[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 david.marchand at redhat.com
Tue May 12 17:29:46 CEST 2026


Hello Arin,

Thanks for the patch.

On Tue, 12 May 2026 at 09:57, Arin Kharkar <arinkharkar at 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 at 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



More information about the dev mailing list