DPDK patches and discussions
 help / color / mirror / Atom feed
From: David Marchand <david.marchand@redhat.com>
To: dev@dpdk.org
Cc: thomas@monjalon.net, bruce.richardson@intel.com
Subject: [PATCH 2/2] doc: use common description of EAL parameters
Date: Thu, 17 Jul 2025 13:46:04 +0200	[thread overview]
Message-ID: <20250717114604.2285791-2-david.marchand@redhat.com> (raw)
In-Reply-To: <20250717114604.2285791-1-david.marchand@redhat.com>

Rather than have a subset of the EAL parameters described in the sample
apps documentation, prefer referring to the full list.

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
 doc/guides/freebsd_gsg/build_sample_apps.rst | 33 +--------
 doc/guides/linux_gsg/build_sample_apps.rst   | 75 +-------------------
 2 files changed, 2 insertions(+), 106 deletions(-)

diff --git a/doc/guides/freebsd_gsg/build_sample_apps.rst b/doc/guides/freebsd_gsg/build_sample_apps.rst
index 5212c1a0b4..db01b16e18 100644
--- a/doc/guides/freebsd_gsg/build_sample_apps.rst
+++ b/doc/guides/freebsd_gsg/build_sample_apps.rst
@@ -57,38 +57,7 @@ Running a Sample Application
     Abstraction Layer (EAL) library, which provides some options that are generic
     to every DPDK application.
 
-A large number of options can be given to the EAL when running an
-application. A full list of options can be got by passing `--help` to a
-DPDK application. Some of the EAL options for FreeBSD are as follows:
-
-*   ``-l CORELIST``:
-    A comma-separated list of the cores, or ranges of cores to run on.
-    For example, ``-l 0,1,4-6`` will run on cores 0, 1, 4, 5 and 6.
-    Note that core numbering can change between platforms and should be determined beforehand.
-
-*   ``-b <domain:bus:devid.func>``:
-    Blocklisting of ports; prevent EAL from using specified PCI device
-    (multiple ``-b`` options are allowed).
-
-*   ``-v``:
-    Display version information on startup.
-
-*   ``-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``:
-    Memory to allocate from hugepages on specific sockets.
-
-*   ``--huge-dir``:
-    The directory where hugetlbfs is mounted.
-
-*   ``--mbuf-pool-ops-name``:
-    Pool ops name for mbuf to use.
-
-*   ``--file-prefix``:
-    The prefix text used for hugepage filenames.
+You can refer to :doc:`freebsd_eal_parameters` for the list of EAL options.
 
 .. _running_non_root:
 
diff --git a/doc/guides/linux_gsg/build_sample_apps.rst b/doc/guides/linux_gsg/build_sample_apps.rst
index aed184fc33..49f88357da 100644
--- a/doc/guides/linux_gsg/build_sample_apps.rst
+++ b/doc/guides/linux_gsg/build_sample_apps.rst
@@ -29,80 +29,7 @@ Running a Sample Application
 The application is linked with the DPDK target environment's Environmental Abstraction Layer (EAL) library,
 which provides some options that are generic to every DPDK application.
 
-The following is the list of options that can be given to the EAL:
-
-.. code-block:: console
-
-    ./rte-app [-l CORELIST] [-n NUM] [-b <domain:bus:devid.func>] \
-              [--numa-mem=MB,...] [-d LIB.so|DIR] [-m MB] [-r NUM] [-v] [--file-prefix] \
-	      [--proc-type <primary|secondary|auto>]
-
-The EAL options are as follows:
-
-* ``-l CORELIST``:
-  A comma-separated list of the cores, or ranges of cores to run on.
-  For example, ``-l 0,1,4-6`` will run on cores 0, 1, 4, 5 and 6.
-  Note that core numbering can change between platforms and should be determined beforehand.
-
-* ``-n NUM``:
-  Number of memory channels per processor socket.
-
-* ``-b <domain:bus:devid.func>``:
-  Blocklisting of ports; prevent EAL from using specified PCI device
-  (multiple ``-b`` options are allowed).
-
-* ``--numa-mem``:
-  Memory to allocate from hugepages on specific sockets. In dynamic memory mode,
-  this memory will also be pinned (i.e. not released back to the system until
-  application closes).
-
-* ``--numa-limit``:
-  Limit maximum memory available for allocation on each socket. Does not support
-  legacy memory mode.
-
-* ``-d``:
-  Add a driver or driver directory to be loaded.
-  The application should use this option to load the PMDs
-  that are built as shared libraries.
-
-* ``-m MB``:
-  Memory to allocate from hugepages, regardless of processor socket. It is
-  recommended that ``--numa-mem`` be used instead of this option.
-
-* ``-r NUM``:
-  Number of memory ranks.
-
-* ``-v``:
-  Display version information on startup.
-
-* ``--huge-dir``:
-  The directory where hugetlbfs is mounted.
-
-* ``--mbuf-pool-ops-name``:
-  Pool ops name for mbuf to use.
-
-* ``--file-prefix``:
-  The prefix text used for hugepage filenames.
-
-* ``--proc-type``:
-  The type of process instance.
-
-* ``--vmware-tsc-map``:
-  Use VMware TSC map instead of native RDTSC.
-
-* ``--base-virtaddr``:
-  Specify base virtual address.
-
-* ``--vfio-intr``:
-  Specify interrupt type to be used by VFIO (has no effect if VFIO is not used).
-
-* ``--legacy-mem``:
-  Run DPDK in legacy memory mode (disable memory reserve/unreserve at runtime,
-  but provide more IOVA-contiguous memory).
-
-* ``--single-file-segments``:
-  Store memory segments in fewer files (dynamic memory mode only - does not
-  affect legacy memory mode).
+You can refer to :doc:`linux_eal_parameters` for the list of EAL options.
 
 Copy the DPDK application binary to your target, then run the application as follows
 (assuming the platform has four memory channels per processor socket,
-- 
2.50.0


  reply	other threads:[~2025-07-17 11:46 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-07-17 11:46 [PATCH 1/2] doc: remove reference to device selection option David Marchand
2025-07-17 11:46 ` David Marchand [this message]
2025-07-17 12:15   ` [PATCH 2/2] doc: use common description of EAL parameters Bruce Richardson
2025-07-17 12:14 ` [PATCH 1/2] doc: remove reference to device selection option Bruce Richardson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250717114604.2285791-2-david.marchand@redhat.com \
    --to=david.marchand@redhat.com \
    --cc=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=thomas@monjalon.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).