diff mbox series

doc/af_xdp: fix bind flags option typo

Message ID 1656fdf94704e9e735df0f8b97667d8f26dd098b.1625550240.git.baruch@tkos.co.il
State New
Headers show
Series doc/af_xdp: fix bind flags option typo | expand

Commit Message

Baruch Siach July 6, 2021, 5:44 a.m. UTC
Use 'XDP_ZEROCOPY' as this options is named in if_xdp.h.

Signed-off-by: Baruch Siach <baruch@tkos.co.il>
---
 Documentation/networking/af_xdp.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Magnus Karlsson July 12, 2021, 8:30 a.m. UTC | #1
On Tue, Jul 6, 2021 at 7:50 AM Baruch Siach <baruch@tkos.co.il> wrote:
>

> Use 'XDP_ZEROCOPY' as this options is named in if_xdp.h.

>

> Signed-off-by: Baruch Siach <baruch@tkos.co.il>

> ---

>  Documentation/networking/af_xdp.rst | 6 +++---

>  1 file changed, 3 insertions(+), 3 deletions(-)


Thanks Baruch! Sorry for the delay. Been on vacation for a week.

Acked-by: Magnus Karlsson <magnus.karlsson@intel.com>


> diff --git a/Documentation/networking/af_xdp.rst b/Documentation/networking/af_xdp.rst

> index 42576880aa4a..60b217b436be 100644

> --- a/Documentation/networking/af_xdp.rst

> +++ b/Documentation/networking/af_xdp.rst

> @@ -243,8 +243,8 @@ Configuration Flags and Socket Options

>  These are the various configuration flags that can be used to control

>  and monitor the behavior of AF_XDP sockets.

>

> -XDP_COPY and XDP_ZERO_COPY bind flags

> --------------------------------------

> +XDP_COPY and XDP_ZEROCOPY bind flags

> +------------------------------------

>

>  When you bind to a socket, the kernel will first try to use zero-copy

>  copy. If zero-copy is not supported, it will fall back on using copy

> @@ -252,7 +252,7 @@ mode, i.e. copying all packets out to user space. But if you would

>  like to force a certain mode, you can use the following flags. If you

>  pass the XDP_COPY flag to the bind call, the kernel will force the

>  socket into copy mode. If it cannot use copy mode, the bind call will

> -fail with an error. Conversely, the XDP_ZERO_COPY flag will force the

> +fail with an error. Conversely, the XDP_ZEROCOPY flag will force the

>  socket into zero-copy mode or fail.

>

>  XDP_SHARED_UMEM bind flag

> --

> 2.30.2

>
patchwork-bot+netdevbpf@kernel.org July 12, 2021, 3 p.m. UTC | #2
Hello:

This patch was applied to bpf/bpf.git (refs/heads/master):

On Tue,  6 Jul 2021 08:44:00 +0300 you wrote:
> Use 'XDP_ZEROCOPY' as this options is named in if_xdp.h.

> 

> Signed-off-by: Baruch Siach <baruch@tkos.co.il>

> ---

>  Documentation/networking/af_xdp.rst | 6 +++---

>  1 file changed, 3 insertions(+), 3 deletions(-)


Here is the summary with links:
  - doc/af_xdp: fix bind flags option typo
    https://git.kernel.org/bpf/bpf/c/f35e0cc25280

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

Patch

diff --git a/Documentation/networking/af_xdp.rst b/Documentation/networking/af_xdp.rst
index 42576880aa4a..60b217b436be 100644
--- a/Documentation/networking/af_xdp.rst
+++ b/Documentation/networking/af_xdp.rst
@@ -243,8 +243,8 @@  Configuration Flags and Socket Options
 These are the various configuration flags that can be used to control
 and monitor the behavior of AF_XDP sockets.
 
-XDP_COPY and XDP_ZERO_COPY bind flags
--------------------------------------
+XDP_COPY and XDP_ZEROCOPY bind flags
+------------------------------------
 
 When you bind to a socket, the kernel will first try to use zero-copy
 copy. If zero-copy is not supported, it will fall back on using copy
@@ -252,7 +252,7 @@  mode, i.e. copying all packets out to user space. But if you would
 like to force a certain mode, you can use the following flags. If you
 pass the XDP_COPY flag to the bind call, the kernel will force the
 socket into copy mode. If it cannot use copy mode, the bind call will
-fail with an error. Conversely, the XDP_ZERO_COPY flag will force the
+fail with an error. Conversely, the XDP_ZEROCOPY flag will force the
 socket into zero-copy mode or fail.
 
 XDP_SHARED_UMEM bind flag