From patchwork Wed Apr 27 21:59:34 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 66843 Delivered-To: patch@linaro.org Received: by 10.140.93.198 with SMTP id d64csp2432810qge; Wed, 27 Apr 2016 15:04:42 -0700 (PDT) X-Received: by 10.50.30.73 with SMTP id q9mr30717281igh.77.1461794681993; Wed, 27 Apr 2016 15:04:41 -0700 (PDT) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id b76si12409855ioj.157.2016.04.27.15.04.41; Wed, 27 Apr 2016 15:04:41 -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; 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; dmarc=pass (p=NONE dis=NONE) header.from=linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 3BD5461105; Wed, 27 Apr 2016 22:04: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=-2.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H2, 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 80212611FB; Wed, 27 Apr 2016 22:04:18 +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 07083611F7; Wed, 27 Apr 2016 22:04:08 +0000 (UTC) Received: from mail-qg0-f51.google.com (mail-qg0-f51.google.com [209.85.192.51]) by lists.linaro.org (Postfix) with ESMTPS id A2701611FE for ; Wed, 27 Apr 2016 21:59:50 +0000 (UTC) Received: by mail-qg0-f51.google.com with SMTP id 90so7365749qgz.1 for ; Wed, 27 Apr 2016 14:59:50 -0700 (PDT) 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:mime-version :content-transfer-encoding; bh=1I6l6U1frYqJaidMW8pz56Wh3Ez+TsXya+c6Aj3+Zvw=; b=Rt9FVJhsfCwFMOhPX5LYCcKeuTVVbgltEC0K8/j1bA6JisCb5yN5awyNDH7fQzdUQ8 bEHGFEzK+QPZuMJYti/PKdrEMlczg/GDmQmYLQ5P2ShQ6eb04KGtWFmFWTIFGRrJSKXn YCobzrYue6CBXscgegP/m5y3MuaQnVXB3JcFROop4GFYmm0d81hug5famel4k36fXiBW 0lcj5ABdv4AviOZOrBPv7ZJ5kGTGBOqNy5Df4sqnq9Wx0VFdS7ZImTsvodxSL98Fe+4U 2sqn/bo/yFq/hZupziWd1hai3wT/jysZ7rtG2d3MI1oA+MO3OagT0MkmFVCmg2Ddyfte GVxg== X-Gm-Message-State: AOPr4FUH2a/+gOJ35vqGm4ioYiLrJiDQk6lP7eA9lULzaxmW0O91WCb3mN5zDfEQiC4s8qvFtxs= X-Received: by 10.141.47.66 with SMTP id y63mr11468821qhe.74.1461794390344; Wed, 27 Apr 2016 14:59:50 -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 d145sm1859506qhc.31.2016.04.27.14.59.49 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 27 Apr 2016 14:59:49 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Wed, 27 Apr 2016 17:59:34 -0400 Message-Id: <1461794375-15214-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 2.7.4 MIME-Version: 1.0 X-Topics: patch Subject: [lng-odp] [API-NEXT PATCH 1/2] doc: support ascidoctor 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: , Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" ascidoctor is a python asciidoc interpreter it has greater capabilities than asciidoc which is a perl based interpreter The resulting style sheet improvements result in more professional looking docs that can be further enhanced with our own css at some point. This also supports including code snippets in the documentation from the doxygen specification files. Signed-off-by: Mike Holmes Reviewed-by: Bill Fischofer --- DEPENDENCIES | 2 +- doc/Makefile.inc | 4 ++-- doc/users-guide/users-guide-tm.adoc | 18 +++++++++--------- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/DEPENDENCIES b/DEPENDENCIES index c83fc36..678b62a 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -252,4 +252,4 @@ The tested version of doxygen is 1.8.8 5.2.1 HTML # Debian/Ubuntu - $ apt-get install asciidoc source-highlight librsvg2-bin + $ apt-get install asciidoctor source-highlight librsvg2-bin diff --git a/doc/Makefile.inc b/doc/Makefile.inc index c0b641e..643b1d4 100644 --- a/doc/Makefile.inc +++ b/doc/Makefile.inc @@ -7,6 +7,6 @@ VPATH=$(top_builddir)/doc/images dot -T svg $^ -o $@ .adoc.html: - asciidoc $(ASCIIDOC_FLAGS) --out-file=$@ $< + asciidoctor $(ASCIIDOC_FLAGS) --out-file=$@ $< -ASCIIDOC_FLAGS =-a data-uri -b html5 -a icons -a toc2 -a max-width=55em +ASCIIDOC_FLAGS =-a data-uri -b html5 -a icons=font -a toc2 diff --git a/doc/users-guide/users-guide-tm.adoc b/doc/users-guide/users-guide-tm.adoc index 132fdc1..5dc2190 100644 --- a/doc/users-guide/users-guide-tm.adoc +++ b/doc/users-guide/users-guide-tm.adoc @@ -269,7 +269,7 @@ result in faster operation and/or less memory used. [source,c] ---- - odp_tm_params_init(&tm_params); /* <1> */ + odp_tm_params_init(&tm_params); // <1> tm_params.pktio = egress_pktio; tm = odp_tm_create(“Example TM”, &tm_params); @@ -285,11 +285,11 @@ result in faster operation and/or less memory used. tmq_B2 = odp_tm_queue_create(tm, &queue_params); tmq_C2 = odp_tm_queue_create(tm, &queue_params); - odp_tm_node_params_init(&node_params); /* <2> */ + odp_tm_node_params_init(&node_params); // <2> node_params.level = 1; tm_node_1 = odp_tm_node_create(tm, “TmNode1”, &node_params); - odp_tm_queue_connect(tmq_A1, tm_node_1); /* <3> */ + odp_tm_queue_connect(tmq_A1, tm_node_1); // <3> odp_tm_queue_connect(tmq_B1, tm_node_1); odp_tm_queue_connect(tmq_A2, tm_node_1); odp_tm_queue_connect(tmq_B2, tm_node_1); @@ -302,7 +302,7 @@ code does is create a scheduler PROFILE, which is effectively a registered set of common scheduler parameters. NOTE that this uses some pseudocode below instead of real C code so as to be more concise. */ - odp_tm_sched_params_init(&sched_params); /* <4> */ + odp_tm_sched_params_init(&sched_params); // <4> sched_params.sched_modes = { ODP_TM_FRAME_BASED_WEIGHTS, … }; sched_params.sched_weights = { 8, 8, 8, … }; sched_profile_RR = odp_tm_sched_create(“SchedProfileRR”, &sched_params); @@ -311,24 +311,24 @@ instead of real C code so as to be more concise. */ sched_params.sched_weights = { 8, 8, 8, … }; sched_profile_FQ = odp_tm_sched_create(“SchedProfileFQ”, &sched_params); - odp_tm_queue_sched_config(tm_node_1, tmq_A1, sched_profile_RR); /* <5> */ + odp_tm_queue_sched_config(tm_node_1, tmq_A1, sched_profile_RR); // <5> odp_tm_queue_sched_config(tm_node_1, tmq_B1, sched_profile_RR); odp_tm_queue_sched_config(tm_node_1, tmq_A2, sched_profile_FQ); odp_tm_queue_sched_config(tm_node_1, tmq_B2, sched_profile_FQ); odp_tm_queue_sched_config(tm_node_1, tmq_C2, sched_profile_FQ); - odp_tm_node_params_init(&node_params); /* <6> */ + odp_tm_node_params_init(&node_params); // <6> node_params.level = 2; tm_node_2 = odp_tm_node_create(tm, “TmNode2”, &node_params); - odp_tm_node_connect(tm_node_1, tm_node_2); /* <7> */ + odp_tm_node_connect(tm_node_1, tm_node_2); // <7> - odp_tm_sched_params_init(&sched_params); /* <8> */ + odp_tm_sched_params_init(&sched_params); // <8> sched_params.sched_modes = { ODP_TM_BYTE_BASED_WEIGHTS, … }; sched_params.sched_weights = { 8, 16, 24, … }; sched_profile_WFQ = odp_tm_sched_create(“SchedProfileWFQ”, &sched_params); - odp_tm_node_sched_config(tm_node_2, tm_node_1, sched_profile_WFQ); /* <9> */ + odp_tm_node_sched_config(tm_node_2, tm_node_1, sched_profile_WFQ); // <9> ---- <1> Create a tm system, since that is a precursor to creating tm_queues.