> -----Original Message-----
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Declan Doherty
> Sent: Friday, April 8, 2016 5:17 PM
> To: dev at dpdk.org
> Cc: Doherty, Declan <declan.doherty at 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 at 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 at intel.com>
