From patchwork Thu Oct 22 19:56:13 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 55452 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-wi0-f197.google.com (mail-wi0-f197.google.com [209.85.212.197]) by patches.linaro.org (Postfix) with ESMTPS id D52D022AA5 for ; Thu, 22 Oct 2015 19:58:45 +0000 (UTC) Received: by wikv3 with SMTP id v3sf1299054wik.1 for ; Thu, 22 Oct 2015 12:58:45 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:delivered-to:from:to:date :message-id:subject:precedence:list-id:list-unsubscribe:list-archive :list-post:list-help:list-subscribe:mime-version:content-type :content-transfer-encoding:errors-to:sender:x-original-sender :x-original-authentication-results:mailing-list; bh=3d+C87N9E0etUO2/JH8tkEOJcymZt6WZvV5vYbp4M5o=; b=TFgwGC0H/CpFA7b3tWwI2MIMaX71GjvaFt/XScDS0oS1ILpowNvHlAvtzszQlSl97n tAnBwsxb9QqbvC8TFLyrbhj3hD0HVt3/3n1EMUQt+w0T3rh3mdNQAcDBlZNHveuthQOL 0seCwzU0mJ5yPOwP9tzrd2Iy70BOMSBsWVA/hq0hmkXK4wD7kQs3zTh9zwbjPjgZ5O5R PbLZQmMX2CwPGoC65Mkyum6D+UlApzE84BYu5tgAt8hcprMB0OslpYWIhTXubBJo9keU MX3YDB75PzubFBzBmx1IHj8VY9NKNPIIqUq2KCpfmVdhug+N+nJAgb5C4JaJCPGyi1XZ V6rA== X-Gm-Message-State: ALoCoQnubJEg1EA8mWuVWGPVOcZMjLwMhkTIa7/rC9Sg+Nx3jDTIbbBOxIC0gP6zo4z2yuwQI7ud X-Received: by 10.180.109.129 with SMTP id hs1mr58778wib.1.1445543925165; Thu, 22 Oct 2015 12:58:45 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.25.151.149 with SMTP id z143ls321173lfd.104.gmail; Thu, 22 Oct 2015 12:58:45 -0700 (PDT) X-Received: by 10.25.79.14 with SMTP id d14mr5968641lfb.40.1445543924979; Thu, 22 Oct 2015 12:58:44 -0700 (PDT) Received: from mail-lf0-x230.google.com (mail-lf0-x230.google.com. [2a00:1450:4010:c07::230]) by mx.google.com with ESMTPS id p72si10602773lfp.112.2015.10.22.12.58.44 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 22 Oct 2015 12:58:44 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 2a00:1450:4010:c07::230 as permitted sender) client-ip=2a00:1450:4010:c07::230; Received: by lfbn126 with SMTP id n126so26553854lfb.2 for ; Thu, 22 Oct 2015 12:58:44 -0700 (PDT) X-Received: by 10.112.64.41 with SMTP id l9mr8436007lbs.32.1445543924784; Thu, 22 Oct 2015 12:58:44 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.112.59.35 with SMTP id w3csp800280lbq; Thu, 22 Oct 2015 12:58:42 -0700 (PDT) X-Received: by 10.140.202.202 with SMTP id x193mr8656672qha.71.1445543922328; Thu, 22 Oct 2015 12:58:42 -0700 (PDT) Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id m12si14944397qkh.56.2015.10.22.12.58.41; Thu, 22 Oct 2015 12:58:42 -0700 (PDT) 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; Received: by lists.linaro.org (Postfix, from userid 109) id CA9EE619A8; Thu, 22 Oct 2015 19:58:41 +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 A0A5862C22; Thu, 22 Oct 2015 19:57:01 +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 5D79362C0E; Thu, 22 Oct 2015 19:56:34 +0000 (UTC) Received: from mail-qg0-f50.google.com (mail-qg0-f50.google.com [209.85.192.50]) by lists.linaro.org (Postfix) with ESMTPS id 180C161CD9 for ; Thu, 22 Oct 2015 19:56:27 +0000 (UTC) Received: by qgeo38 with SMTP id o38so67165231qge.0 for ; Thu, 22 Oct 2015 12:56:26 -0700 (PDT) X-Received: by 10.140.131.198 with SMTP id 189mr22274665qhd.83.1445543786689; Thu, 22 Oct 2015 12:56:26 -0700 (PDT) Received: from localhost.localdomain (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by smtp.gmail.com with ESMTPSA id s84sm6014716qki.14.2015.10.22.12.56.25 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 22 Oct 2015 12:56:26 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Thu, 22 Oct 2015 15:56:13 -0400 Message-Id: <1445543775-11220-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.5.0 X-Topics: patch Subject: [lng-odp] [PATCH 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: 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" X-Original-Sender: mike.holmes@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 2a00:1450:4010:c07::230 as permitted sender) smtp.mailfrom=patch+caf_=patchwork-forward=linaro.org@linaro.org; dkim=neutral (body hash did not verify) header.i=@linaro_org.20150623.gappssmtp.com Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 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 5d84f92..0d08e58 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +