From: Jack Bond-Preston <jack.bond-preston@foss.arm.com>
To: dev@dpdk.org
Subject: Re: [PATCH 2/2] doc: remove use of -n 4 option in documentation
Date: Fri, 19 Jul 2024 14:37:11 +0100 [thread overview]
Message-ID: <7178392f-bb8a-4ea0-b389-ab28003c8ac3@foss.arm.com> (raw)
In-Reply-To: <20240718184326.21375-2-stephen@networkplumber.org>
On 18/07/2024 19:43, Stephen Hemminger wrote:
> Many places in the documentation are using -n 4 to set
> the number of memory channels. This should not be recommended
> since it is not always right and the default should be used
> instead.
>
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Jack Bond-Preston <jack.bond-preston@foss.arm.com>
> diff --git a/doc/guides/linux_gsg/build_sample_apps.rst b/doc/guides/linux_gsg/build_sample_apps.rst
> index 4f99617233..f07e7a4fb5 100644
> --- a/doc/guides/linux_gsg/build_sample_apps.rst
> +++ b/doc/guides/linux_gsg/build_sample_apps.rst
> @@ -114,7 +114,7 @@ Copy·the·DPDK·application·binary·to·your·target,·then·run·the·application·as·fol
> (assuming·the·platform·has·four·memory·channels·per·processor·socket,
> and·that·cores·0-3·are·present·and·are·to·be·used·for·running·the·application)::
>
> -····./dpdk-helloworld·-l·0-3·-n·4
> +····./dpdk-helloworld·-l·0-3
The comment above about assuming the platform has four memory channels
is still correct I guess (since the default is 4), but it feels out of
place now without the -n option specified in the command line.
> diff --git a/doc/guides/sample_app_ug/link_status_intr.rst b/doc/guides/sample_app_ug/link_status_intr.rst
> index a4c0712bd9..523d2ef718 100644
> --- a/doc/guides/sample_app_ug/link_status_intr.rst
> +++ b/doc/guides/sample_app_ug/link_status_intr.rst
> @@ -54,7 +54,7 @@ issue·the·command:
>
> ..·code-block::·console
>
> -····$·./<build_dir>/examples/dpdk-link_status_interrupt·-l·0-3·-n·4--·-q·8·-p·ffff
> +····$·./<build_dir>/examples/dpdk-link_status_interrupt·-l·0-3--·-q·8·-p·ffff
Same comment applies here. Also, whilst this patch isn't the cause,
should there not be a space before --?
> diff --git a/doc/guides/sample_app_ug/vm_power_management.rst b/doc/guides/sample_app_ug/vm_power_management.rst
> index e0af729e66..d2ef3636eb 100644
> --- a/doc/guides/sample_app_ug/vm_power_management.rst
> +++ b/doc/guides/sample_app_ug/vm_power_management.rst
> @@ -279,7 +279,7 @@ cores·0·and·1·on·a·system·with·four·memory·channels,·issue·the·command:
>
> ..·code-block::·console
>
> -···./<build_dir>/examples/dpdk-vm_power_mgr·-l·0-1·-n·4
> +···./<build_dir>/examples/dpdk-vm_power_mgr·-l·0-1
Same comment.
Should we also remove the note saying "The command line must always have
the number of memory channels specified for the processor." from the
mempool library programmer's guide?
next prev parent reply other threads:[~2024-07-19 13:37 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-18 18:43 [PATCH 1/2] doc: add note about CPU 0 Stephen Hemminger
2024-07-18 18:43 ` [PATCH 2/2] doc: remove use of -n 4 option in documentation Stephen Hemminger
2024-07-19 8:15 ` Bruce Richardson
2024-07-19 13:37 ` Jack Bond-Preston [this message]
2024-07-29 19:59 ` [PATCH 1/2] doc: add note about CPU 0 Thomas Monjalon
2024-07-31 4:38 ` [PATCH v2 " Stephen Hemminger
2024-07-31 4:38 ` [PATCH v2 2/2] doc: remove use of -n 4 option in documentation Stephen Hemminger
2024-07-31 8:16 ` Thomas Monjalon
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=7178392f-bb8a-4ea0-b389-ab28003c8ac3@foss.arm.com \
--to=jack.bond-preston@foss.arm.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;
as well as URLs for NNTP newsgroup(s).