[dpdk-dev] [PATCH v6 10/13] doc: add NXP dpaa2 sec in cryptodev

[Mcnamara, John]

> -----Original Message-----
> From: akhil.goyal at nxp.com [mailto:akhil.goyal at nxp.com]
> Sent: Friday, March 24, 2017 9:58 PM
> To: dev at dpdk.org
> Cc: thomas.monjalon at 6wind.com; Doherty, Declan <declan.doherty at intel.com>;
> De Lara Guarch, Pablo <pablo.de.lara.guarch at intel.com>; Mcnamara, John
> <john.mcnamara at intel.com>; nhorman at tuxdriver.com; hemant.agrawal at nxp.com;
> Akhil Goyal <akhil.goyal at nxp.com>
> Subject: [PATCH v6 10/13] doc: add NXP dpaa2 sec in cryptodev
> 
> From: Akhil Goyal <akhil.goyal at nxp.com>
> 
> Signed-off-by: Akhil Goyal <akhil.goyal at nxp.com>
> Reviewed-by: Hemant Agrawal <hemant.agrawal at nxp.com>
> ---
>  doc/guides/cryptodevs/dpaa2_sec.rst          | 232
> +++++++++++++++++++++++++++
>  doc/guides/cryptodevs/features/dpaa2_sec.ini |  34 ++++
>  doc/guides/cryptodevs/index.rst              |   1 +
>  doc/guides/nics/dpaa2.rst                    |   2 +
>  4 files changed, 269 insertions(+)
>  create mode 100644 doc/guides/cryptodevs/dpaa2_sec.rst
>  create mode 100644 doc/guides/cryptodevs/features/dpaa2_sec.ini
> 
> diff --git a/doc/guides/cryptodevs/dpaa2_sec.rst
> b/doc/guides/cryptodevs/dpaa2_sec.rst
> new file mode 100644
> index 0000000..310fa60
> --- /dev/null
> +++ b/doc/guides/cryptodevs/dpaa2_sec.rst
> @@ -0,0 +1,232 @@
> +..  BSD LICENSE
> +    Copyright(c) 2016 NXP. All rights reserved.
> +
> +    Redistribution and use in source and binary forms, with or without
> +    modification, are permitted provided that the following conditions
> +    are met:
> +
> +    * Redistributions of source code must retain the above copyright
> +    notice, this list of conditions and the following disclaimer.
> +    * Redistributions in binary form must reproduce the above copyright
> +    notice, this list of conditions and the following disclaimer in
> +    the documentation and/or other materials provided with the
> +    distribution.
> +    * Neither the name of NXP nor the names of its
> +    contributors may be used to endorse or promote products derived
> +    from this software without specific prior written permission.
> +
> +    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
> +    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
> +    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
> +    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
> +    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
> +    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
> +    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
> +    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
> +    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
> +    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
> +    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
> +
> +
> +NXP DPAA2 CAAM (DPAA2_SEC)
> +==========================
> +
> +The DPAA2_SEC PMD provides poll mode crypto driver support for NXP
> +DPAA2 CAAM hardware accelerator.
> +
> +Architecture
> +------------
> +
> +SEC is the SOC's security engine, which serves as NXP's latest
> +cryptographic acceleration and offloading hardware. It combines
> +functions previously implemented in separate modules to create a
> +modular and scalable acceleration and assurance engine. It also
> +implements block encryption algorithms, stream cipher algorithms,
> +hashing algorithms, public key algorithms, run-time integrity checking,
> +and a hardware random number generator. SEC performs higher-level
> +cryptographic operations than previous NXP cryptographic accelerators.
> This provides significant improvement to system level performance.
> +
> +DPAA2_SEC is one of the hardware resource in DPAA2 Architecture. More
> +information on DPAA2 Architecture is described in
> +docs/guides/nics/dpaa2.rst

This, and a similar link, don't appear to be converted to links, unless I
missed some part of the patchset.

I see that you added a dpaa2_overview target to doc/guides/nics/dpaa2.rst
so the link here should probably be something like:

    More information on DPAA2 Architecture is described in 
    :ref:`the DPAA2 NIC overview <dpaa2_overview>`.

See http://dpdk.org/doc/guides/contributing/documentation.html#hyperlinks

This occurs in more than one place.

John