From: "Mcnamara, John" <john.mcnamara@intel.com>
To: "Doherty, Declan" <declan.doherty@intel.com>,
"dev@dpdk.org" <dev@dpdk.org>
Cc: "Doherty, Declan" <declan.doherty@intel.com>,
"De Lara Guarch, Pablo" <pablo.de.lara.guarch@intel.com>
Subject: Re: [dpdk-dev] [PATCH 2/2] docs: cryptodev chapter for programmer's guide
Date: Fri, 8 Apr 2016 20:05:20 +0000 [thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE202510951@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <1460132247-16553-3-git-send-email-declan.doherty@intel.com>
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Declan Doherty
> Sent: Friday, April 8, 2016 5:17 PM
> To: dev@dpdk.org
> Cc: Doherty, Declan <declan.doherty@intel.com>
> Subject: [dpdk-dev] [PATCH 2/2] docs: cryptodev chapter for programmer's
> guide
>
> Add a programmer's guide section for cryptodev library.
>
> Signed-off-by: Declan Doherty <declan.doherty@intel.com>
Nice doc.
> +
> +
> +Cryptography Device Library
> +=============================
The underline should match the length of the title (documentation guidelines).
Shorter underlines are a warning while longer are allowed but it is best to match.
> +
> +.. code-block:: c
> +
> + /** Crypto device configuration structure */
> + struct rte_cryptodev_config {
> + int socket_id;
> + /**< Socket to allocate resources on */
> + uint16_t nb_queue_pairs;
> + /**< Number of queue pairs to configure on device */
> +
> + struct {
> + uint32_t nb_objs;
> + uint32_t cache_size;
> + } session_mp;
> + /**< Session mempool configuration */
> + };
The code blocks contain tabs instead of spaces (documentation guidelines).
This renders a little oddly for the longer examples.
Apart from these very minor comments:
Acked-by: John McNamara <john.mcnamara@intel.com>
next prev parent reply other threads:[~2016-04-08 20:05 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-04-08 16:17 [dpdk-dev] [PATCH 0/2] cryptodev documentation patches Declan Doherty
2016-04-08 16:17 ` [dpdk-dev] [PATCH 1/2] docs: add cryptodevs guide overview section Declan Doherty
2016-04-08 18:13 ` De Lara Guarch, Pablo
2016-04-08 20:08 ` Mcnamara, John
2016-04-08 16:17 ` [dpdk-dev] [PATCH 2/2] docs: cryptodev chapter for programmer's guide Declan Doherty
2016-04-08 18:16 ` De Lara Guarch, Pablo
2016-04-08 20:05 ` Mcnamara, John [this message]
2016-04-08 22:41 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=B27915DBBA3421428155699D51E4CFE202510951@IRSMSX103.ger.corp.intel.com \
--to=john.mcnamara@intel.com \
--cc=declan.doherty@intel.com \
--cc=dev@dpdk.org \
--cc=pablo.de.lara.guarch@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).