[dpdk-dev] doc: update eal option usage for FreeBSD

Message ID 1524757687-18218-1-git-send-email-reshma.pattan@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail apply patch file failure

Commit Message

Pattan, Reshma April 26, 2018, 3:48 p.m. UTC
  EAL option -m is supported in FreeBSD,
so move it under supported heading from non
supported heading.

Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
---
 doc/guides/freebsd_gsg/build_sample_apps.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
  

Comments

Anatoly Burakov April 27, 2018, 9:20 a.m. UTC | #1
On 26-Apr-18 4:48 PM, Reshma Pattan wrote:
> EAL option -m is supported in FreeBSD,
> so move it under supported heading from non
> supported heading.
> 
> Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
> ---
>   doc/guides/freebsd_gsg/build_sample_apps.rst | 8 ++++----
>   1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/doc/guides/freebsd_gsg/build_sample_apps.rst b/doc/guides/freebsd_gsg/build_sample_apps.rst
> index 90f050232..ac92260f1 100644
> --- a/doc/guides/freebsd_gsg/build_sample_apps.rst
> +++ b/doc/guides/freebsd_gsg/build_sample_apps.rst
> @@ -128,6 +128,10 @@ The EAL options for FreeBSD are as follows:
>   *   ``--proc-type``:
>       The type of process instance.
>   
> +*   ``-m MB``:
> +    Memory to allocate from hugepages, regardless of processor socket.
> +    It is recommended that ``--socket-mem`` be used instead of this option.
> +

--socket-mem is not supported on FreeBSD (because no NUMA support), so 
the comment about recommending it is wrong.
  
Pattan, Reshma April 27, 2018, 9:22 a.m. UTC | #2
> -----Original Message-----

> From: Burakov, Anatoly

> Sent: Friday, April 27, 2018 10:21 AM

> To: Pattan, Reshma <reshma.pattan@intel.com>; Mcnamara, John

> <john.mcnamara@intel.com>; dev@dpdk.org

> Subject: Re: [dpdk-dev] [PATCH] doc: update eal option usage for FreeBSD

> 

> On 26-Apr-18 4:48 PM, Reshma Pattan wrote:

> > EAL option -m is supported in FreeBSD, so move it under supported

> > heading from non supported heading.

> >

> > Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>

> > ---

> >   doc/guides/freebsd_gsg/build_sample_apps.rst | 8 ++++----

> >   1 file changed, 4 insertions(+), 4 deletions(-)

> >

> > diff --git a/doc/guides/freebsd_gsg/build_sample_apps.rst

> > b/doc/guides/freebsd_gsg/build_sample_apps.rst

> > index 90f050232..ac92260f1 100644

> > --- a/doc/guides/freebsd_gsg/build_sample_apps.rst

> > +++ b/doc/guides/freebsd_gsg/build_sample_apps.rst

> > @@ -128,6 +128,10 @@ The EAL options for FreeBSD are as follows:

> >   *   ``--proc-type``:

> >       The type of process instance.

> >

> > +*   ``-m MB``:

> > +    Memory to allocate from hugepages, regardless of processor socket.

> > +    It is recommended that ``--socket-mem`` be used instead of this option.

> > +

> 

> --socket-mem is not supported on FreeBSD (because no NUMA support), so

> the comment about recommending it is wrong.


Ohh yes, my bad :-( I will recorrect it.

> 

> --

> Thanks,

> Anatoly
  

Patch

diff --git a/doc/guides/freebsd_gsg/build_sample_apps.rst b/doc/guides/freebsd_gsg/build_sample_apps.rst
index 90f050232..ac92260f1 100644
--- a/doc/guides/freebsd_gsg/build_sample_apps.rst
+++ b/doc/guides/freebsd_gsg/build_sample_apps.rst
@@ -128,6 +128,10 @@  The EAL options for FreeBSD are as follows:
 *   ``--proc-type``:
     The type of process instance.
 
+*   ``-m MB``:
+    Memory to allocate from hugepages, regardless of processor socket.
+    It is recommended that ``--socket-mem`` be used instead of this option.
+
 Other options, specific to Linux and are not supported under FreeBSD are as follows:
 
 *   ``socket-mem``:
@@ -142,10 +146,6 @@  Other options, specific to Linux and are not supported under FreeBSD are as foll
 *   ``--file-prefix``:
     The prefix text used for hugepage filenames.
 
-*   ``-m MB``:
-    Memory to allocate from hugepages, regardless of processor socket.
-    It is recommended that ``--socket-mem`` be used instead of this option.
-
 The ``-c`` or ``-l`` option is mandatory; the others are optional.
 
 Copy the DPDK application binary to your target, then run the application