[PATCH 18/29] doc/guides: improve Hello World sample app guide

Stephen Hemminger
2026-01-14T22:27:02Z

Improve the Hello World sample application documentation:
- capitalize Linux consistently
- fix "helloworld" to "Hello World" in description
- add missing articles and commas

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

diff --git a/doc/guides/sample_app_ug/hello_world.rst b/doc/guides/sample_app_ug/hello_world.rst
index 5bfd4b3fda..8f22bb2260 100644
--- a/doc/guides/sample_app_ug/hello_world.rst
+++ b/doc/guides/sample_app_ug/hello_world.rst
@@ -9,25 +9,25 @@ Overview
--------

The Hello World sample application is an example of the simplest DPDK application that can be written.
-The application simply prints an "helloworld" message on every enabled lcore.
+The application simply prints a "Hello World" message on every enabled lcore.

Compiling the Application
-------------------------

-To compile the sample application see :doc:`compiling`.
+To compile the sample application, see :doc:`compiling`.

The application is located in the ``helloworld`` sub-directory.

Running the Application
-----------------------

-To run the example in a linux environment:
+To run the example in a Linux environment:

.. code-block:: console

$ ./<build_dir>/examples/dpdk-helloworld -l 0-3

-Refer to *DPDK Getting Started Guide* for general information on running applications
+Refer to the *DPDK Getting Started Guide* for general information on running applications
and the Environment Abstraction Layer (EAL) options.

Explanation
@@ -46,7 +46,7 @@ This is done in the main() function using the following code:
:start-after: Initialization of Environment Abstraction Layer (EAL). 8<
:end-before: >8 End of initialization of Environment Abstraction Layer

-This call finishes the initialization process that was started before main() is called (in case of a Linux environment).
+This call finishes the initialization process that was started before main() is called (in the case of a Linux environment).
The argc and argv arguments are provided to the rte_eal_init() function.
The value returned is the number of parsed arguments.

--
2.51.0