doc: document all EAL parameters in one place
authorAnatoly Burakov <anatoly.burakov@intel.com>
Mon, 19 Nov 2018 13:10:26 +0000 (13:10 +0000)
committerThomas Monjalon <thomas@monjalon.net>
Fri, 23 Nov 2018 10:50:11 +0000 (11:50 +0100)
commit3ee567cfec37386707ee71ef432f63d3fb810fec
treebe2c5c00b50e81eb80353108c4d24b0083317e7f
parentfdb650267f8c646d89299456e7a59ed2a4c53d86
doc: document all EAL parameters in one place

Currently, the most complete (but still incomplete) user guide for
EAL command-line parameters resides in user guide for testpmd.
This is wrong on multiple levels, and should not be the case.

To fix it, we have to create a document that lists all supported
EAL command-line arguments. However, because different platforms
support different subsets of available EAL parameters, instead of
creating a single file, we will create a common file in
doc/guides/common containing documentation for EAL parameters
that are supported on all of our supported platforms (Linux and
FreeBSD at the time of this writing).

We will then include this document in the Getting Started guides
for all supported platforms, so that any changes made to
documentation for commonly supported EAL parameters will be
reflected in Getting Started guides for all platforms.

This patch also removes EAL parameters documentation from the
testpmd user guide, and instead adds references to the newly
created documents in both testpmd user guides and in sample
applications guide.

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Reviewed-by: Rami Rosen <roszenrami@gmail.com>
doc/guides/freebsd_gsg/freebsd_eal_parameters.rst [new file with mode: 0644]
doc/guides/freebsd_gsg/index.rst
doc/guides/linux_gsg/eal_args.include.rst [new file with mode: 0644]
doc/guides/linux_gsg/index.rst
doc/guides/linux_gsg/linux_eal_parameters.rst [new file with mode: 0644]
doc/guides/sample_app_ug/intro.rst
doc/guides/testpmd_app_ug/run_app.rst