Re: [dpdk-dev] [PATCH 1/5] app/test-flow-perf: add flow performance skeleton

[Ajit Khaparde <ajit.khaparde@broadcom.com>]

::snip::


> +
> +Running the Application
> +=======================
> +
> +EAL Command-line Options
> +------------------------
> +
> +Please refer to :doc:`EAL parameters (Linux)
> <../linux_gsg/linux_eal_parameters>`
> +or :doc:`EAL parameters (FreeBSD)
> <../freebsd_gsg/freebsd_eal_parameters>` for
> +a list of available EAL command-line options.
> +
> +
> +Flow performance Options
> +------------------------
> +
> +The following are the command-line options for the flow performance
> application.
> +They must be separated from the EAL options, shown in the previous
> section, with
> +a ``--`` separator:
> +
> +.. code-block:: console
> +
> +       sudo ./test-flow-perf -n 4 -w 08:00.0,dv_flow_en=1 --
>
Since this is a generic usage doc, the specific arg should not be specified
here.
This example could be in the vendor/pmd specific usage guide though.


> +
> +The command line options are:
> +
> +*      ``--help``
> +       Display a help message and quit.
> diff --git a/doc/guides/tools/index.rst b/doc/guides/tools/index.rst
> index 782b30864e..7279daebc6 100644
> --- a/doc/guides/tools/index.rst
> +++ b/doc/guides/tools/index.rst
> @@ -16,3 +16,4 @@ DPDK Tools User Guides
>      cryptoperf
>      comp_perf
>      testeventdev
> +    flow-perf
> --
> 2.17.1
>
>