[PATCH] Fixed outdated documentation on the hello world doc, which incorrectly stated an easier way to launch the lcore_hello function. The example program uses the simpler version and the documentation stating it as an "equivalent and simpler" alternative is moot. It is now the default.

[PATCH] Fixed outdated documentation on the hello world doc, which incorrectly stated an easier way to launch the lcore_hello function. The example program uses the simpler version and the documentation stating it as an "equivalent and simpler" alternative is moot. It is now the default.

[Arin Kharkar]

Signed-off-by: Arin Kharkar <arinkharkar@gmail.com>
---
 doc/guides/sample_app_ug/hello_world.rst | 8 --------
 1 file changed, 8 deletions(-)

diff --git a/doc/guides/sample_app_ug/hello_world.rst b/doc/guides/sample_app_ug/hello_world.rst
index 5bfd4b3fda..b7167aa345 100644
--- a/doc/guides/sample_app_ug/hello_world.rst
+++ b/doc/guides/sample_app_ug/hello_world.rst
@@ -70,12 +70,4 @@ The code that launches the function on each lcore is as follows:
     :end-before: >8 End of launching the function on each lcore.
     :dedent: 1
 
-The following code is equivalent and simpler:
-
-.. literalinclude:: ../../../examples/helloworld/main.c
-    :language: c
-    :start-after: Simpler equivalent. 8<
-    :end-before: >8 End of simpler equivalent.
-    :dedent: 2
-
 Refer to the *DPDK API Reference* for detailed information on the rte_eal_mp_remote_launch() function.
-- 
2.43.0

Re: [PATCH] Fixed outdated documentation on the hello world doc, which incorrectly stated an easier way to launch the lcore_hello function. The example program uses the simpler version and the documentation stating it as an "equivalent and simpler" alternative is moot. It is now the default.

[David Marchand]

Hello Arin,

Thanks for the patch.

On Tue, 12 May 2026 at 09:57, Arin Kharkar <arinkharkar@gmail.com> wrote:

You'll have to add a title so that your commitlog does not end up as the title.

>
> Signed-off-by: Arin Kharkar <arinkharkar@gmail.com>
> ---
>  doc/guides/sample_app_ug/hello_world.rst | 8 --------
>  1 file changed, 8 deletions(-)
>
> diff --git a/doc/guides/sample_app_ug/hello_world.rst b/doc/guides/sample_app_ug/hello_world.rst
> index 5bfd4b3fda..b7167aa345 100644
> --- a/doc/guides/sample_app_ug/hello_world.rst
> +++ b/doc/guides/sample_app_ug/hello_world.rst
> @@ -70,12 +70,4 @@ The code that launches the function on each lcore is as follows:
>      :end-before: >8 End of launching the function on each lcore.
>      :dedent: 1
>
> -The following code is equivalent and simpler:
> -
> -.. literalinclude:: ../../../examples/helloworld/main.c
> -    :language: c
> -    :start-after: Simpler equivalent. 8<
> -    :end-before: >8 End of simpler equivalent.
> -    :dedent: 2
> -
>  Refer to the *DPDK API Reference* for detailed information on the rte_eal_mp_remote_launch() function.
> --
> 2.43.0
>

Please also drop the associated "Simpler equivalent. 8>" and ">8 End
of simpler equivalent." comments from the example source code.


-- 
David Marchand

[PATCH] Remove redundant simpler equivalent section

[Arin Kharkar]

Fixed outdated documentation on the hello world doc, which incorrectly stated an easier way to launch the lcore_hello function. The example program uses the simpler version and the documentation stating it as an "equivalent and simpler" alternative is moot. It is now the default.

Signed-off-by: Arin Kharkar <arinkharkar@gmail.com>
---
 doc/guides/sample_app_ug/hello_world.rst | 8 --------
 examples/helloworld/main.c               | 4 +---
 2 files changed, 1 insertion(+), 11 deletions(-)

diff --git a/doc/guides/sample_app_ug/hello_world.rst b/doc/guides/sample_app_ug/hello_world.rst
index 5bfd4b3fda..b7167aa345 100644
--- a/doc/guides/sample_app_ug/hello_world.rst
+++ b/doc/guides/sample_app_ug/hello_world.rst
@@ -70,12 +70,4 @@ The code that launches the function on each lcore is as follows:
     :end-before: >8 End of launching the function on each lcore.
     :dedent: 1
 
-The following code is equivalent and simpler:
-
-.. literalinclude:: ../../../examples/helloworld/main.c
-    :language: c
-    :start-after: Simpler equivalent. 8<
-    :end-before: >8 End of simpler equivalent.
-    :dedent: 2
-
 Refer to the *DPDK API Reference* for detailed information on the rte_eal_mp_remote_launch() function.
diff --git a/examples/helloworld/main.c b/examples/helloworld/main.c
index af509138da..8d1a959c58 100644
--- a/examples/helloworld/main.c
+++ b/examples/helloworld/main.c
@@ -40,13 +40,11 @@ main(int argc, char **argv)
 
 	/* Launches the function on each lcore. 8< */
 	RTE_LCORE_FOREACH_WORKER(lcore_id) {
-		/* Simpler equivalent. 8< */
 		rte_eal_remote_launch(lcore_hello, NULL, lcore_id);
-		/* >8 End of simpler equivalent. */
 	}
 
 	/* call it on main lcore too */
-	lcore_hello(NULL);
+	 lcore_hello(NULL);
 	/* >8 End of launching the function on each lcore. */
 
 	rte_eal_mp_wait_lcore();
-- 
2.43.0