numam-dpdk/doc/guides/freebsd_gsg
Anatoly Burakov 3ee567cfec 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>
2018-11-23 11:50:11 +01:00
..
build_dpdk.rst doc: convert Intel license headers to SPDX tags 2018-02-06 23:27:08 +01:00
build_sample_apps.rst doc: update memory option usage for FreeBSD 2018-04-28 00:07:31 +02:00
freebsd_eal_parameters.rst doc: document all EAL parameters in one place 2018-11-23 11:50:11 +01:00
index.rst doc: document all EAL parameters in one place 2018-11-23 11:50:11 +01:00
install_from_ports.rst doc: convert Intel license headers to SPDX tags 2018-02-06 23:27:08 +01:00
intro.rst doc: convert Intel license headers to SPDX tags 2018-02-06 23:27:08 +01:00