Re: [dpdk-dev] [PATCH] doc: update the doc for adding EAL option

["Burakov, Anatoly" <anatoly.burakov@intel.com>]

Hi Eric,

Ferruh has already mention that this should be part of the patch adding 
the --iova-mode flag, not separate (or at the very least be in the same 
patchset!).

In addition, the commit headline is very vague. Suggested rewording:

doc: document --iova-mode EAL flag

On 01-Oct-18 4:54 PM, eric zhang wrote:
> This patch updates Programmer's Guide and EAL parameter guides
> to show EAL option "--iova-mode" support.
> 
> Signed-off-by: eric zhang <eric.zhang@windriver.com>
> ---
>   doc/guides/prog_guide/env_abstraction_layer.rst | 8 ++++++++
>   doc/guides/testpmd_app_ug/run_app.rst           | 4 ++++
>   2 files changed, 12 insertions(+)
> 
> diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst
> index d362c92..a47fb38 100644
> --- a/doc/guides/prog_guide/env_abstraction_layer.rst
> +++ b/doc/guides/prog_guide/env_abstraction_layer.rst
> @@ -321,6 +321,14 @@ Misc Functions
>   
>   Locks and atomic operations are per-architecture (i686 and x86_64).
>   
> +IOVA Mode Configuration
> +~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Auto detection of the IOVA mode, based on probing the PCI bus and IOMMU configuration, may not report
> +the desired addressing mode when virtual devices that are not directly attached to the PCI bus are present.
> +To facilitate forcing the IOVA mode to a specific value the EAL command line option ``--iova-mode=mode`` can
> +be used to select either physical addressing('pa') or virtual addressing('va').

Presumably this isn't only applicable to PCI bus, but can be any bus, 
correct?

> +
>   Memory Segments and Memory Zones (memzone)
>   ------------------------------------------
>   
> diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
> index f301c2b..be2911c 100644
> --- a/doc/guides/testpmd_app_ug/run_app.rst
> +++ b/doc/guides/testpmd_app_ug/run_app.rst
> @@ -133,6 +133,10 @@ See the DPDK Getting Started Guides for more information on these options.

I wanted to ask why are you adding this to testpmd user guide, as this 
is an EAL parameter, not a testpmd parameter, but as far as i can tell, 
there isn't a central location where we document all EAL flags.

+Thomas, John

This looks like a gap in our documentation. There should be a place 
where we can describe all EAL parameters. Since they can be OS-specific, 
it probably should be somewhere under Linux/FreeBSD GSG. Thoughts?

>   
>       Use malloc instead of hugetlbfs.
>   
> +*   ``--iova-mode=mode``

Current style is to list all valid values, like this:

``--iova-mode <pa|va>``

> +
> +    Force IOVA mode to a specific value. Valid values are 'pa' or 'va'.
> +
>   
>   Testpmd Command-line Options
>   ----------------------------
> 


-- 
Thanks,
Anatoly