DPDK-dev Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>
Subject: [PATCH 04/15] doc: improve structure and clarity of compiling guide
Date: Thu, 11 Jun 2026 14:18:43 -0700	[thread overview]
Message-ID: <20260611212119.1026721-5-stephen@networkplumber.org> (raw)
In-Reply-To: <20260611212119.1026721-1-stephen@networkplumber.org>

Restructured the sample applications compiling guide:
- Added clearer section headers with proper capitalization
- Improved command block formatting and indentation consistency
- Added setup instructions for build directory creation
- Clarified the distinction between meson and make approaches
- Enhanced explanations with better context for each step
- Added note about flexible build directory naming
- Improved overall document flow and readability

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/sample_app_ug/compiling.rst | 84 ++++++++++++++++----------
 1 file changed, 51 insertions(+), 33 deletions(-)

diff --git a/doc/guides/sample_app_ug/compiling.rst b/doc/guides/sample_app_ug/compiling.rst
index adde775d4e..a68a9e713c 100644
--- a/doc/guides/sample_app_ug/compiling.rst
+++ b/doc/guides/sample_app_ug/compiling.rst
@@ -5,79 +5,97 @@ Compiling the Sample Applications
 =================================
 
 This section explains how to compile the DPDK sample applications.
+Sample applications are located in ``dpdk/examples/``.
 
-To compile all the sample applications
---------------------------------------
+To Compile All the Sample Applications
+---------------------------------------
 
-Go to DPDK build directory:
+Set up the build directory (if not already done):
 
-    .. code-block:: console
+.. code-block:: console
 
-       cd dpdk/<build_dir>
+   cd dpdk
+   meson setup build
 
-Enable examples compilation:
+.. note::
 
-   .. code-block:: console
+   The build directory name (``build`` in this example) can be chosen freely.
+   Replace ``<build_dir>`` in subsequent commands with your chosen directory name.
 
-      meson configure -Dexamples=all
+Go to the build directory:
 
-Build:
+.. code-block:: console
 
-   .. code-block:: console
+   cd build
 
-      ninja
+.. code-block:: console
+
+   meson configure -Dexamples=all
+
+Compile:
+
+.. code-block:: console
+
+   ninja
 
 For additional information on compiling see
 :ref:`Compiling DPDK on Linux <linux_gsg_compiling_dpdk>` or
 :ref:`Compiling DPDK on FreeBSD <building_from_source>`.
-Applications are output to: ``dpdk/<build_dir>/examples``.
 
+Compiled applications are output to ``dpdk/<build_dir>/examples``.
 
-To compile a single application
--------------------------------
 
+To Compile a Single Application
+--------------------------------
+
+A single application can be compiled using meson during the DPDK build,
+or standalone using make with an installed DPDK.
 
 Using meson
 ~~~~~~~~~~~
 
-Go to DPDK build directory:
+Go to the build directory (after ``meson setup`` as shown above):
 
-    .. code-block:: console
+.. code-block:: console
 
-       cd dpdk/<build_dir>
+   cd dpdk/build
 
 Enable example app compilation:
 
-   .. code-block:: console
+.. code-block:: console
+
+   meson configure -Dexamples=helloworld
+
+Compile:
 
-      meson configure -Dexamples=helloworld
+.. code-block:: console
 
-Build:
+   ninja
 
-   .. code-block:: console
 
-      ninja
+Using make (standalone)
+~~~~~~~~~~~~~~~~~~~~~~~
 
+To compile a sample application standalone using make, DPDK must first
+be installed on the system and pkg-config must be configured.
+See :ref:`building_app_using_installed_dpdk` for installation instructions.
 
-Using Make
-~~~~~~~~~~
+Go to the sample application directory:
 
-Pkg-config is used when building an example app standalone using make, please
-see :ref:`building_app_using_installed_dpdk` for more information.
+.. code-block:: console
 
-Go to the sample application directory. Unless otherwise specified the sample
-applications are located in ``dpdk/examples/``.
+   cd dpdk/examples/helloworld
 
 Build the application:
 
-    .. code-block:: console
+.. code-block:: console
 
-        make
+   make
 
 To build the application for debugging use the ``DEBUG`` option.
 This option adds some extra flags, disables compiler optimizations and
-sets verbose output.
+sets verbose output:
 
-    .. code-block:: console
+.. code-block:: console
 
-       make DEBUG=1
+   make DEBUG=1
-- 
2.53.0


  parent reply	other threads:[~2026-06-11 21:21 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-01-27 17:47 [PATCH] doc: reword sample application guides Nandini Persad
2025-02-16 23:09 ` [PATCH v2] " Nandini Persad
2025-02-20 12:26   ` Burakov, Anatoly
2026-06-11 21:18   ` [PATCH 00/15] doc: clean up " Stephen Hemminger
2026-06-11 21:18     ` [PATCH 01/15] doc: cleanups to bbdev sample application Stephen Hemminger
2026-06-11 21:18     ` [PATCH 02/15] doc: cleanup cmd_line example documentation Stephen Hemminger
2026-06-11 21:18     ` [PATCH 03/15] doc: cleanup the distribution sample application guide Stephen Hemminger
2026-06-11 21:18     ` Stephen Hemminger [this message]
2026-06-11 21:18     ` [PATCH 05/15] doc: improve clarity and consistency in DMA sample app guide Stephen Hemminger
2026-06-15  9:50       ` fengchengwen
2026-06-11 21:18     ` [PATCH 06/15] doc: correct capitalization and formatting in ethtool guide Stephen Hemminger
2026-06-11 21:18     ` [PATCH 07/15] doc: improve clarity in eventdev, FIPS, and flow filtering Stephen Hemminger
2026-06-11 21:18     ` [PATCH 08/15] doc: enhance hello_world, intro, IP frag and pipeline Stephen Hemminger
2026-06-11 21:18     ` [PATCH 09/15] doc: improve IP reassembly, IPsec, multicast, and keep-alive Stephen Hemminger
2026-06-12 10:06       ` Radu Nicolau
2026-06-11 21:18     ` [PATCH 10/15] doc: enhance L2 forwarding sample application guides Stephen Hemminger
2026-06-11 21:18     ` [PATCH 11/15] doc: enhance multi-process, NTB, ordering, and PTP guides Stephen Hemminger
2026-06-11 21:18     ` [PATCH 12/15] doc: improve QoS, callbacks, EFD, and service cores guides Stephen Hemminger
2026-06-11 21:18     ` [PATCH 13/15] doc: enhance skeleton, pipeline, timer, and vhost guides Stephen Hemminger
2026-06-11 21:18     ` [PATCH 14/15] doc: improve vhost, VM power, and VMDq sample guides Stephen Hemminger
2026-06-11 21:18     ` [PATCH 15/15] doc: correct grammar and punctuation consistency issues Stephen Hemminger
2026-06-12 10:06       ` Radu Nicolau

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=20260611212119.1026721-5-stephen@networkplumber.org \
    --to=stephen@networkplumber.org \
    --cc=dev@dpdk.org \
    /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