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

Message ID 1524833963-7316-1-git-send-email-reshma.pattan@intel.com (mailing list archive)
State Accepted, archived
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Pattan, Reshma April 27, 2018, 12:59 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>
---
v2: remove recommendation of socket-mem option.
---
 doc/guides/freebsd_gsg/build_sample_apps.rst | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)
  

Comments

Anatoly Burakov April 27, 2018, 1:14 p.m. UTC | #1
On 27-Apr-18 1:59 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>
> ---
> v2: remove recommendation of socket-mem option.
> ---

Reviewed-by: Anatoly Burakov <anatoly.burakov@intel.com>
  
Thomas Monjalon April 27, 2018, 10:08 p.m. UTC | #2
27/04/2018 15:14, Burakov, Anatoly:
> On 27-Apr-18 1:59 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>
> > ---
> > v2: remove recommendation of socket-mem option.
> > ---
> 
> Reviewed-by: Anatoly Burakov <anatoly.burakov@intel.com>

Applied, thanks
  

Patch

diff --git a/doc/guides/freebsd_gsg/build_sample_apps.rst b/doc/guides/freebsd_gsg/build_sample_apps.rst
index 90f050232..a085b6187 100644
--- a/doc/guides/freebsd_gsg/build_sample_apps.rst
+++ b/doc/guides/freebsd_gsg/build_sample_apps.rst
@@ -128,6 +128,9 @@  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.
+
 Other options, specific to Linux and are not supported under FreeBSD are as follows:
 
 *   ``socket-mem``:
@@ -142,10 +145,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