DPDK-dev Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Arin Kharkar <arinkharkar@gmail.com>
To: dev@dpdk.org
Cc: Arin Kharkar <arinkharkar@gmail.com>
Subject: [PATCH] Remove redundant simpler equivalent section
Date: Tue, 12 May 2026 12:16:50 -0700	[thread overview]
Message-ID: <20260512191651.126274-1-arinkharkar@gmail.com> (raw)
In-Reply-To: <CAJFAV8zBGUVp-Df3aqY_pUw-JZpVqJfXERXsw4oQ+k2_TJbu2Q@mail.gmail.com>

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


      reply	other threads:[~2026-05-13 12:35 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-11 23:33 [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
2026-05-12 15:29 ` David Marchand
2026-05-12 19:16   ` Arin Kharkar [this message]

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=20260512191651.126274-1-arinkharkar@gmail.com \
    --to=arinkharkar@gmail.com \
    --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