[PATCH net-next] docs: fix the path of example code and example commands for device memory TCP

[PATCH net-next] docs: fix the path of example code and example commands for device memory TCP

[Yui Washizu]

This updates the old path and fixes the description of unavailable options.

Signed-off-by: Yui Washizu <yui.washidu@gmail.com>
---
 Documentation/networking/devmem.rst | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/Documentation/networking/devmem.rst b/Documentation/networking/devmem.rst
index d95363645331..eb678ca45496 100644
--- a/Documentation/networking/devmem.rst
+++ b/Documentation/networking/devmem.rst
@@ -256,7 +256,7 @@ Testing
 =======
 
 More realistic example code can be found in the kernel source under
-``tools/testing/selftests/net/ncdevmem.c``
+``tools/testing/selftests/drivers/net/hw/ncdevmem.c``
 
 ncdevmem is a devmem TCP netcat. It works very similarly to netcat, but
 receives data directly into a udmabuf.
@@ -268,8 +268,7 @@ ncdevmem has a validation mode as well that expects a repeating pattern of
 incoming data and validates it as such. For example, you can launch
 ncdevmem on the server by::
 
-	ncdevmem -s <server IP> -c <client IP> -f eth1 -d 3 -n 0000:06:00.0 -l \
-		 -p 5201 -v 7
+	ncdevmem -s <server IP> -c <client IP> -f <ifname> -l -p 5201 -v 7
 
 On client side, use regular netcat to send TX data to ncdevmem process
 on the server::
-- 
2.43.5

Re: [PATCH net-next] docs: fix the path of example code and example commands for device memory TCP

[Simon Horman]

On Tue, Mar 18, 2025 at 03:12:41PM +0900, Yui Washizu wrote:
> This updates the old path and fixes the description of unavailable options.
> 
> Signed-off-by: Yui Washizu <yui.washidu@gmail.com>

Thanks,

On inspection this patch looks good to me although
I am unaware of the history of the -n and -d options.

I suppose this could have been two patches as it does two things.
But it seems simple enough to me in its current form.

Reviewed-by: Simon Horman <horms@kernel.org>

...

Re: [PATCH net-next] docs: fix the path of example code and example commands for device memory TCP

[Mina Almasry]

On Mon, Mar 17, 2025 at 11:14 PM Yui Washizu <yui.washidu@gmail.com> wrote:
>
> This updates the old path and fixes the description of unavailable options.
>
> Signed-off-by: Yui Washizu <yui.washidu@gmail.com>

Thank you, I think when I updated some of the implementations of
ncdevmem I didn't update the docs:

Reviewed-by: Mina Almasry <almasrymina@google.com>

> ---
>  Documentation/networking/devmem.rst | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/networking/devmem.rst b/Documentation/networking/devmem.rst
> index d95363645331..eb678ca45496 100644
> --- a/Documentation/networking/devmem.rst
> +++ b/Documentation/networking/devmem.rst
> @@ -256,7 +256,7 @@ Testing
>  =======
>
>  More realistic example code can be found in the kernel source under
> -``tools/testing/selftests/net/ncdevmem.c``
> +``tools/testing/selftests/drivers/net/hw/ncdevmem.c``
>
>  ncdevmem is a devmem TCP netcat. It works very similarly to netcat, but
>  receives data directly into a udmabuf.
> @@ -268,8 +268,7 @@ ncdevmem has a validation mode as well that expects a repeating pattern of
>  incoming data and validates it as such. For example, you can launch
>  ncdevmem on the server by::
>
> -       ncdevmem -s <server IP> -c <client IP> -f eth1 -d 3 -n 0000:06:00.0 -l \
> -                -p 5201 -v 7
> +       ncdevmem -s <server IP> -c <client IP> -f <ifname> -l -p 5201 -v 7
>
>  On client side, use regular netcat to send TX data to ncdevmem process
>  on the server::
> --
> 2.43.5
>


-- 
Thanks,
Mina

Re: [PATCH net-next] docs: fix the path of example code and example commands for device memory TCP

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Tue, 18 Mar 2025 15:12:41 +0900 you wrote:
> This updates the old path and fixes the description of unavailable options.
> 
> Signed-off-by: Yui Washizu <yui.washidu@gmail.com>
> ---
>  Documentation/networking/devmem.rst | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)

Here is the summary with links:
  - [net-next] docs: fix the path of example code and example commands for device memory TCP
    https://git.kernel.org/netdev/net-next/c/f8e1bcec62ef

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html