From patchwork Mon Nov 2 17:41:15 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 55906 Delivered-To: patch@linaro.org Received: by 10.112.61.134 with SMTP id p6csp1397308lbr; Mon, 2 Nov 2015 09:45:02 -0800 (PST) X-Received: by 10.31.180.1 with SMTP id d1mr15583802vkf.131.1446486302718; Mon, 02 Nov 2015 09:45:02 -0800 (PST) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id 185si13074610vkn.196.2015.11.02.09.45.02; Mon, 02 Nov 2015 09:45:02 -0800 (PST) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dkim=neutral (body hash did not verify) header.i=@linaro_org.20150623.gappssmtp.com Received: by lists.linaro.org (Postfix, from userid 109) id D5BA961A0D; Mon, 2 Nov 2015 17:44:40 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 X-Spam-Level: X-Spam-Status: No, score=-1.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, T_DKIM_INVALID,URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 636A561B3B; Mon, 2 Nov 2015 17:42:00 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 1086D61B5C; Mon, 2 Nov 2015 17:41:37 +0000 (UTC) Received: from mail-qk0-f173.google.com (mail-qk0-f173.google.com [209.85.220.173]) by lists.linaro.org (Postfix) with ESMTPS id B535861835 for ; Mon, 2 Nov 2015 17:41:24 +0000 (UTC) Received: by qkcn129 with SMTP id n129so61299402qkc.1 for ; Mon, 02 Nov 2015 09:41:24 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro_org.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id; bh=600t6ZuOA+lo99s4kJfn+z43JvoFsv9u4T2xITKuFbY=; b=t/05YuwuRatyPy6Ge1+ABtsunADvwbalnyeYL8bbL6nzrQNhGs03TTA8P2lMWVdmrG CYLGOpk8TM5MR75GnAOoOqn+JdgocQfjRd3YHUfQN57qOwOfzPCkBDbx8FltUxzskUvB 1/rMAdOpnJh0527PHHZpOsJtQgmd1Set281+wymThnUuV2eVSZYUytsHBh0jlhnBVKMR Kd3LloBMRTUYtYOeHjdlLv6yD4yJwXqu9VBkhFTWhpqxZ2Pd8imtb+GJ85okorxUKlki SHTHQ7b1JAdCW434TgOEuhog6s3OsKjvh3dVVlOYIUlNrfmVfFCm8yAnazvaKbgRlUZR rw2A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=600t6ZuOA+lo99s4kJfn+z43JvoFsv9u4T2xITKuFbY=; b=NGoH1DQmkcf4WQdtpO6FuEG5AGDnF+6zU7eYml3JWyj7TKN3qazqyC6EkoYHO2sWM1 YxpkB5tEsRsA0s0A5C5QqUswvG0s2YpWH5uN4cmUnK25RRHQnSDOQE+dlLE9a7KQS2/6 DxLGbt9I3nxbUHU+qhT3L9at2kCEL/hXg99i8rHI0bzXkZ9xqI3WHeboeH2DBRF6XXEc DMXH3sljaec87rBiFYdrevB06iL/BRnULPiRgrI3tHozeSG9lL0aBk8vJhhnMwwsW1hr tVC/yy14n+t5RrnkwhuGpekPXnbsoQsud4bah4IRlVlhonB7FAAItjOqccHSPHol9nIo aH3g== X-Gm-Message-State: ALoCoQkZ+cpfwu3QWgWnyfva0j2OcfJb1AsztYSkyYOH2dMw//VuBj1rkvTMaW+48fHzmMLauCrS X-Received: by 10.55.77.205 with SMTP id a196mr31022365qkb.30.1446486084343; Mon, 02 Nov 2015 09:41:24 -0800 (PST) Received: from localhost.localdomain (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by smtp.gmail.com with ESMTPSA id r67sm8299312qki.17.2015.11.02.09.41.23 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 02 Nov 2015 09:41:23 -0800 (PST) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Mon, 2 Nov 2015 12:41:15 -0500 Message-Id: <1446486077-14973-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.5.0 X-Topics: patch Subject: [lng-odp] [PATCH v2 1/3] doc: images: add svg for user-guide X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" Signed-off-by: Mike Holmes --- DEPENDENCIES | 9 +- configure.ac | 11 + doc/Makefile.am | 4 +- doc/images/.gitignore | 2 + doc/images/Makefile.am | 33 +++ doc/images/atomic_queue.svg | 302 +++++++++++++++++++ doc/images/ordered_queue.svg | 658 ++++++++++++++++++++++++++++++++++++++++++ doc/images/parallel_queue.svg | 470 ++++++++++++++++++++++++++++++ 8 files changed, 1486 insertions(+), 3 deletions(-) create mode 100644 doc/images/.gitignore create mode 100644 doc/images/Makefile.am create mode 100644 doc/images/atomic_queue.svg create mode 100644 doc/images/ordered_queue.svg create mode 100644 doc/images/parallel_queue.svg diff --git a/DEPENDENCIES b/DEPENDENCIES index 51951d7..7d22bde 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -187,7 +187,12 @@ Prerequisites for building the OpenDataPlane (ODP) API ./configure --enable-cunit #if cunit is in the PATH ./configure --with-cunit-path=DIR #only if you need a path to Cunit libs and headers -5.0 Documentation & Doxygen +5.0 Documentation Images & Doxygen + + Images are stored as svg files and the png or eps versions generated when the docs are built + Image magics convert application is used + # Debian/Ubuntu + # apt-get install imagemagick 5.1 API Guide See http://www.stack.nl/~dimitri/doxygen/manual/install.html @@ -206,7 +211,7 @@ The tested version of doxygen is 1.8.8 5.2.1 HTML # Ubuntu - $ apt-get install asciidoc + $ apt-get install asciidoc source-highlight # Debian $ apt-get install asciidoc source-highlight diff --git a/configure.ac b/configure.ac index a7e7413..5cf07ca 100644 --- a/configure.ac +++ b/configure.ac @@ -248,6 +248,16 @@ AC_ARG_ENABLE([user-guides], AM_CONDITIONAL([user_guide], [test "x${user_guides}" = "xyes" ]) ########################################################################## +# Check for imagemagic availability +########################################################################## + AC_CHECK_PROGS([IMAGEMAGIC], [convert]) + if test -z "$IMAGEMAGIC"; + then AC_MSG_WARN([Imagemagic (convert) not found - continuing without image support]) + fi + +AM_CONDITIONAL([HAVE_IMAGEMAGIC], [test "x${IMAGEMAGIC}" = "xconvert"]) + +########################################################################## # Save and set temporary compilation flags ########################################################################## OLD_LDFLAGS=$LDFLAGS @@ -296,6 +306,7 @@ AM_CXXFLAGS="-std=c++11" AC_CONFIG_FILES([Makefile doc/Makefile doc/implementers-guide/Makefile + doc/images/Makefile example/Makefile example/classifier/Makefile example/generator/Makefile diff --git a/doc/Makefile.am b/doc/Makefile.am index 73bd8e2..3aa29a3 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,8 +1,10 @@ +SUBDIRS = images + if HAVE_DOXYGEN clean-local: rm -rf output endif if user_guide -SUBDIRS = implementers-guide +SUBDIRS += implementers-guide endif diff --git a/doc/images/.gitignore b/doc/images/.gitignore new file mode 100644 index 0000000..148f2f2 --- /dev/null +++ b/doc/images/.gitignore @@ -0,0 +1,2 @@ +*.png +*.eps diff --git a/doc/images/Makefile.am b/doc/images/Makefile.am new file mode 100644 index 0000000..df8f9d4 --- /dev/null +++ b/doc/images/Makefile.am @@ -0,0 +1,33 @@ +SVG_SRCS = atomic_queue.svg \ + ordered_queue.svg \ + parallel_queue.svg +SVG_TARGETS = $(SVG_SRCS:svg=png) +SVG_TARGETS += $(SVG_SRCS:svg=eps) + +EXTRA_DIST = $(SVG_SRCS) + +TARGETS= + +if HAVE_IMAGEMAGIC +TARGETS += $(SVG_TARGETS) +endif + +all-local: $(TARGETS) + +clean-local: + rm -f $(TARGETS) + +atomic_queue.png: atomic_queue.svg + convert $< $@ +atomic_queue.eps: atomic_queue.svg + convert $< $@ + +ordered_queue.png: ordered_queue.svg + convert $< $@ +parallel_queue.eps: parallel_queue.svg + convert $< $@ + +parallel_queue.png: parallel_queue.svg + convert $< $@ +ordered_queue.eps: ordered_queue.svg + convert $< $@ diff --git a/doc/images/atomic_queue.svg b/doc/images/atomic_queue.svg new file mode 100644 index 0000000..bd4958f --- /dev/null +++ b/doc/images/atomic_queue.svg @@ -0,0 +1,302 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/images/ordered_queue.svg b/doc/images/ordered_queue.svg new file mode 100644 index 0000000..dfc9c22 --- /dev/null +++ b/doc/images/ordered_queue.svg @@ -0,0 +1,658 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1 + 2 + 5 + 3 + 4 + 6 + 7 + 3 + 2 + 1 + + + + + + + + + + + + diff --git a/doc/images/parallel_queue.svg b/doc/images/parallel_queue.svg new file mode 100644 index 0000000..50e3f38 --- /dev/null +++ b/doc/images/parallel_queue.svg @@ -0,0 +1,470 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +