[dpdk-dev] [PATCH v2 1/3] doc: add usage doc for ENETC PMD

[Ferruh Yigit]

On 9/13/2018 10:41 AM, Gagandeep Singh wrote:
> Add enetc usage document to compile and run the
> DPDK application on enetc supported platform.
> This document introduces the enetc driver, supported
> platforms and supported features.
> 
> Signed-off-by: Gagandeep Singh <g.singh at nxp.com>
> ---
>  MAINTAINERS                        |   5 +
>  doc/guides/nics/enetc.rst          | 153 +++++++++++++++++++++++++++++
>  doc/guides/nics/features/enetc.ini |   8 ++
>  doc/guides/nics/index.rst          |   1 +

Please also add a release note update.
And a web page patch to supported device list: https://core.dpdk.org/supported/

<...>

> +Driver compilation and testing
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +#. Please refer the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
> +   to compile the driver. Use target "arm64-armv8a-linuxapp-gcc" in make command
> +
> +#. Refer to the document :ref:`cross build dpdk for arm64 <configure_and_cross_compile_dpdk_build>` to
> +   disable flags and for cross compilation
> +
> +#. To compile in performance mode, please set ``CONFIG_RTE_CACHE_LINE_SIZE=64``
> +
> +#. Running l2fwd:
> +
> +   Follow instructions available in the document
> +   :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
> +   to run l2fwd.
> +
> +   - First unbind the ports from kernel
> +
> +     - echo vfio-pci > /sys/bus/pci/devices/0000\:00\:00.1/driver_override
> +     - echo 0000:00:00.1 > /sys/bus/pci/drivers/fsl_enetc/unbind
> +     - echo vfio-pci > /sys/bus/pci/devices/0000\:00\:00.0/driver_override
> +     - echo 0000:00:00.0 > /sys/bus/pci/drivers/fsl_enetc/unbind
> +   - Then bind them to VFIO, so that DPDK application can use them
> +
> +     - echo 0000:00:00.1 > /sys/bus/pci/drivers/vfio-pci/bind
> +     - echo 0000:00:00.0 > /sys/bus/pci/drivers/vfio-pci/bind
> +   - Mount Hugepages
> +
> +     - mkdir /mnt/hugepages
> +     - mount -t hugetlbfs none /mnt/hugepages
> +   - Run l2fwd application

We moved common part of documentation into " compiling and testing a PMD for a
NIC" section, check other PMD docs for usage, for example ena PMD, "Usage
example" section.

It is good to keep example output if it has PMD specific logs, but not required
to have generic output.