From patchwork Fri Jan 15 00:06:18 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 59797 Delivered-To: patch@linaro.org Received: by 10.112.130.2 with SMTP id oa2csp207343lbb; Thu, 14 Jan 2016 16:06:37 -0800 (PST) X-Received: by 10.55.71.146 with SMTP id u140mr8914909qka.14.1452816397426; Thu, 14 Jan 2016 16:06:37 -0800 (PST) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id 199si1130557qhp.78.2016.01.14.16.06.36; Thu, 14 Jan 2016 16:06:37 -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 Received: by lists.linaro.org (Postfix, from userid 109) id C6B4E618DA; Fri, 15 Jan 2016 00:06:36 +0000 (UTC) Authentication-Results: lists.linaro.org; dkim=fail reason="verification failed; unprotected key" header.d=linaro.org header.i=@linaro.org header.b=FAQpO+KQ; dkim-adsp=none (unprotected policy); dkim-atps=neutral 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=-2.5 required=5.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, 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 393E7618C8; Fri, 15 Jan 2016 00:06:28 +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 CEC9C618CB; Fri, 15 Jan 2016 00:06:25 +0000 (UTC) Received: from mail-oi0-f53.google.com (mail-oi0-f53.google.com [209.85.218.53]) by lists.linaro.org (Postfix) with ESMTPS id 5C288617AD for ; Fri, 15 Jan 2016 00:06:24 +0000 (UTC) Received: by mail-oi0-f53.google.com with SMTP id w75so94653456oie.0 for ; Thu, 14 Jan 2016 16:06:24 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id; bh=1nGs+Y64T8buWQ5s7t4S3zIfN3kZs6zEtPsLBI9EIvc=; b=FAQpO+KQVJUyKvN6WwAdxBGNmjSjV8j7I/gtPmhsaMiIXumPylzrckGd9vHbzjohZq FLG5rG8LyNQvDQb2OE1s44usyqicGsk65ZeXKpH8F1tckuLPfnqKtCWJAtXUvem4PtQz Pp6OxhVC9EuTeV1c1bl8caHRuZCY1H2uN4af0= 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=1nGs+Y64T8buWQ5s7t4S3zIfN3kZs6zEtPsLBI9EIvc=; b=iY9S1vgtKqRb3xCGH9wXa6WPrxso3vrFo33X8d6sizLRD0wUxUuTG7l93CrNCCr3nu HvoioTQcTSvaU8tf7JWdKGVCEqd9VeIkHHcZBMrGI4Db//pMToVe+hPrTreDXaUPUgk8 8fcqQJZIYGBunSTXwN+xvSxWHwrXlPcgBalsHNEWLMySXPE3nR6EoMty9IVvjRr2Hy1U 484p40DaMeKIRtLeSQcrxheVwr4ETkKhSDPBbwjAwdIz9S8nPjLneXBGaT1Ba6k7KBn3 3HK5VTe6zDQdJURADHnGoPfnwBe2pWMHpOKfrU3nOyVyOjt6jVH1hDM/SWWoLjNRGrVU Hq6A== X-Gm-Message-State: ALoCoQkk+PuZ/3kXjNZ4lgQfldeCE4nUhHq6s9V/IHIeGfE5A4Q/ZzLWE3Tq3duIWh+/jbpj6O45XroM9Qco4ylbKPd9VWwUIA== X-Received: by 10.202.75.205 with SMTP id y196mr5655032oia.130.1452816383847; Thu, 14 Jan 2016 16:06:23 -0800 (PST) Received: from Ubuntu15.localdomain (cpe-66-68-129-43.austin.res.rr.com. [66.68.129.43]) by smtp.gmail.com with ESMTPSA id m67sm5014101oik.4.2016.01.14.16.06.22 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 14 Jan 2016 16:06:23 -0800 (PST) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Thu, 14 Jan 2016 18:06:18 -0600 Message-Id: <1452816379-12299-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.5.0 X-Topics: patch Subject: [lng-odp] [API-NEXT PATCHv5 1/2] doc: remove imagemagic dependency and use svg diagrams in all asciidocs 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" Simplify ODP documentation builds by using .svg files directly for all images. This eliminates the need to create .png and .eps files via the imagemagic package. Note that this removes easy PDF output for ODP user documents, however there is no real demand for such capability. Signed-off-by: Bill Fischofer --- configure.ac | 10 --------- doc/images/.gitignore | 3 +-- doc/images/Makefile.am | 39 ++++++------------------------------ doc/odp.dox | 2 +- doc/process-guide/release-guide.adoc | 4 ++-- doc/users-guide/users-guide.adoc | 18 ++++++++--------- 6 files changed, 19 insertions(+), 57 deletions(-) diff --git a/configure.ac b/configure.ac index 4f89f03..5c10d7f 100644 --- a/configure.ac +++ b/configure.ac @@ -262,16 +262,6 @@ 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"]) - -########################################################################## # Check for mscgen availability ########################################################################## AC_CHECK_PROGS([MSCGEN], [mscgen]) diff --git a/doc/images/.gitignore b/doc/images/.gitignore index 148f2f2..1647e41 100644 --- a/doc/images/.gitignore +++ b/doc/images/.gitignore @@ -1,2 +1 @@ -*.png -*.eps +resource_management.svg diff --git a/doc/images/Makefile.am b/doc/images/Makefile.am index 8ab03b4..8fb8a99 100644 --- a/doc/images/Makefile.am +++ b/doc/images/Makefile.am @@ -1,43 +1,16 @@ -.svg.png: - convert $^ $@ - -.svg.eps: - convert $^ $@ - -.msc.png: - mscgen -T png -i $^ -o $@ - -SVG_SRCS = \ - atomic_queue.svg \ - ordered_queue.svg \ - parallel_queue.svg \ - odp_components.svg \ - odp_rx_processing.svg \ - odp_scheduling.svg \ - odp_traffic_manager.svg \ - overview.svg \ - release_git.svg \ - simple_release_git.svg - -SVG_TARGETS = $(SVG_SRCS:svg=png) -SVG_TARGETS += $(SVG_SRCS:svg=eps) +.msc.svg: + mscgen -T svg -i $^ -o $@ MSG_SRCS = resource_management.msc -MSG_TARGETS = $(MSG_SRCS:msc=png) +MSG_TARGETS = $(MSG_SRCS:msc=svg) -EXTRA_DIST = $(SVG_SRCS) $(MSG_SRCS) - -TARGETS=$(SVG_TARGETS) $(MSG_TARGETS) - -if HAVE_IMAGEMAGIC -TARGETS += $(SVG_TARGETS) -endif +EXTRA_DIST = $(MSG_SRCS) if HAVE_MSCGEN -TARGETS += $(MSG_TARGETS) +TARGETS = $(MSG_TARGETS) endif all-local: $(TARGETS) clean-local: - rm -f $(SVG_TARGETS) $(MSG_TARGETS) + rm -f $(MSG_TARGETS) diff --git a/doc/odp.dox b/doc/odp.dox index 0bff5ad..5792179 100644 --- a/doc/odp.dox +++ b/doc/odp.dox @@ -17,7 +17,7 @@ * also be useful for those wishing to implement ODP on other * platforms. * - * @image html overview.png + * @image html overview.svg * * ODP consists of a common layer and an implementation layer. * Applications written to the common layer are portable across all diff --git a/doc/process-guide/release-guide.adoc b/doc/process-guide/release-guide.adoc index 5bef890..302e058 100644 --- a/doc/process-guide/release-guide.adoc +++ b/doc/process-guide/release-guide.adoc @@ -31,7 +31,7 @@ where a major release is to be made and applied atomically, this flow can be seen in Figure 1. .Overview of the ODP git process -image::../images/simple_release_git.png[align="center"] +image::../images/simple_release_git.svg[align="center"] Regular bug fixes, and implementation changes occur directly to master. @@ -46,7 +46,7 @@ cherry picked work so that it may be applied to master on release day, this can be seen in detail in Figure 2. .Overview of the ODP git process -image::../images/release_git.png[align="center"] +image::../images/release_git.svg[align="center"] === api-next === acceptance criteria for patches to api-next (path 1): diff --git a/doc/users-guide/users-guide.adoc b/doc/users-guide/users-guide.adoc index 6f7dd86..45fe4a8 100644 --- a/doc/users-guide/users-guide.adoc +++ b/doc/users-guide/users-guide.adoc @@ -12,7 +12,7 @@ Further details about ODP may be found at the http://opendataplane.org[ODP] home page. .Overview of a system running ODP applications -image::../images/overview.png[align="center"] +image::../images/overview.svg[align="center"] ODP is an API specification that allows many implementations to provide platform independence, automatic hardware acceleration and CPU scaling to @@ -22,7 +22,7 @@ write an application that can successfully take advantage of the API. :numbered: == Introduction .OpenDataPlane Components -image::../images/odp_components.png[align="center"] +image::../images/odp_components.svg[align="center"] .The ODP API Specification ODP consists of three separate but related component parts. First, ODP is an @@ -360,7 +360,7 @@ The *Classifier* provides a suite of APIs that control packet receive (RX) processing. .ODP Receive Processing with Classifier -image::../images/odp_rx_processing.png[align="center"] +image::../images/odp_rx_processing.svg[align="center"] The classifier provides two logically related services: [horizontal] @@ -397,7 +397,7 @@ The *Scheduler* provides a suite of APIs that control scalable event processing. .ODP Scheduler and Event Processing -image::../images/odp_scheduling.png[align="center"] +image::../images/odp_scheduling.svg[align="center"] The Scheduler is responsible for selecting and dispatching one or more events to a requesting thread. Event selection is based on several factors involving @@ -429,7 +429,7 @@ The *Traffic Manager* provides a suite of APIs that control traffic shaping and Quality of Service (QoS) processing for packet output. .ODP Transmit processing with Traffic Manager -image::../images/odp_traffic_manager.png[align="center"] +image::../images/odp_traffic_manager.svg[align="center"] The final stage of packet processing is to transmit it. Here, applications have several choices. As with RX processing, applications may send packets @@ -508,7 +508,7 @@ Shutdown is the logical reverse of the initialization procedure, with called to terminate ODP. .ODP Application Structure Flow Diagram -image::../images/resource_management.png[align="center"] +image::../images/resource_management.svg[align="center"] == Common Conventions Many ODP APIs share common conventions regarding their arguments and return @@ -636,7 +636,7 @@ SCHED queues that specify a sync mode of ODP_SCHED_SYNC_NONE are unrestricted in how events are processed. .Parallel Queue Scheduling -image::../images/parallel_queue.png[align="center"] +image::../images/parallel_queue.svg[align="center"] All events held on parallel queues are eligible to be scheduled simultaneously and any required synchronization between them is the responsibility of the @@ -658,7 +658,7 @@ more events from the same atomic queue if *odp_schedule_multi()* is used. In this case these multiple events all share the same atomic scheduling context. .Atomic Queue Scheduling -image::../images/atomic_queue.png[align="center"] +image::../images/atomic_queue.svg[align="center"] In this example, no matter how many events may be held in an atomic queue, only one calling thread can receive scheduled events from it at a time. Here @@ -678,7 +678,7 @@ scaleabilty of parallel queues, with the easy synchronization of atomic queues. .Ordered Queue Scheduling -image::../images/ordered_queue.png[align="center"] +image::../images/ordered_queue.svg[align="center"] When scheduling events from an ordered queue, the scheduler dispatches multiple events from the queue in parallel to different threads, however the scheduler