[PATCH] Documentation/networking: fix af_xdp.rst Sphinx warnings

[PATCH] Documentation/networking: fix af_xdp.rst Sphinx warnings

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

Fix Sphinx warnings in Documentation/networking/af_xdp.rst by
adding indentation:

Documentation/networking/af_xdp.rst:319: WARNING: Literal block expected; none found.
Documentation/networking/af_xdp.rst:326: WARNING: Literal block expected; none found.

Fixes: 0f4a9b7d4ecb ("xsk: add FAQ to facilitate for first time users")

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Magnus Karlsson <magnus.karlsson@intel.com>
Cc: Daniel Borkmann <daniel@iogearbox.net>
---
 Documentation/networking/af_xdp.rst |    8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

--- lnx-52-rc1.orig/Documentation/networking/af_xdp.rst
+++ lnx-52-rc1/Documentation/networking/af_xdp.rst
@@ -316,16 +316,16 @@ A: When a netdev of a physical NIC is in
    all the traffic, you can force the netdev to only have 1 queue, queue
    id 0, and then bind to queue 0. You can use ethtool to do this::
 
-   sudo ethtool -L <interface> combined 1
+     sudo ethtool -L <interface> combined 1
 
    If you want to only see part of the traffic, you can program the
    NIC through ethtool to filter out your traffic to a single queue id
    that you can bind your XDP socket to. Here is one example in which
    UDP traffic to and from port 4242 are sent to queue 2::
 
-   sudo ethtool -N <interface> rx-flow-hash udp4 fn
-   sudo ethtool -N <interface> flow-type udp4 src-port 4242 dst-port \
-   4242 action 2
+     sudo ethtool -N <interface> rx-flow-hash udp4 fn
+     sudo ethtool -N <interface> flow-type udp4 src-port 4242 dst-port \
+     4242 action 2
 
    A number of other ways are possible all up to the capabilitites of
    the NIC you have.

Re: [PATCH] Documentation/networking: fix af_xdp.rst Sphinx warnings

[Björn Töpel]

On Mon, 20 May 2019 at 23:23, Randy Dunlap <rdunlap@infradead.org> wrote:
>
> From: Randy Dunlap <rdunlap@infradead.org>
>
> Fix Sphinx warnings in Documentation/networking/af_xdp.rst by
> adding indentation:
>
> Documentation/networking/af_xdp.rst:319: WARNING: Literal block expected; none found.
> Documentation/networking/af_xdp.rst:326: WARNING: Literal block expected; none found.
>
> Fixes: 0f4a9b7d4ecb ("xsk: add FAQ to facilitate for first time users")
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Magnus Karlsson <magnus.karlsson@intel.com>
> Cc: Daniel Borkmann <daniel@iogearbox.net>
> ---
>  Documentation/networking/af_xdp.rst |    8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> --- lnx-52-rc1.orig/Documentation/networking/af_xdp.rst
> +++ lnx-52-rc1/Documentation/networking/af_xdp.rst
> @@ -316,16 +316,16 @@ A: When a netdev of a physical NIC is in
>     all the traffic, you can force the netdev to only have 1 queue, queue
>     id 0, and then bind to queue 0. You can use ethtool to do this::
>
> -   sudo ethtool -L <interface> combined 1
> +     sudo ethtool -L <interface> combined 1
>
>     If you want to only see part of the traffic, you can program the
>     NIC through ethtool to filter out your traffic to a single queue id
>     that you can bind your XDP socket to. Here is one example in which
>     UDP traffic to and from port 4242 are sent to queue 2::
>
> -   sudo ethtool -N <interface> rx-flow-hash udp4 fn
> -   sudo ethtool -N <interface> flow-type udp4 src-port 4242 dst-port \
> -   4242 action 2
> +     sudo ethtool -N <interface> rx-flow-hash udp4 fn
> +     sudo ethtool -N <interface> flow-type udp4 src-port 4242 dst-port \
> +     4242 action 2
>
>     A number of other ways are possible all up to the capabilitites of
>     the NIC you have.
>
>

Acked-by: Björn Töpel <bjorn.topel@intel.com>

Re: [PATCH] Documentation/networking: fix af_xdp.rst Sphinx warnings

[Daniel Borkmann]

On 05/20/2019 11:22 PM, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix Sphinx warnings in Documentation/networking/af_xdp.rst by
> adding indentation:
> 
> Documentation/networking/af_xdp.rst:319: WARNING: Literal block expected; none found.
> Documentation/networking/af_xdp.rst:326: WARNING: Literal block expected; none found.
> 
> Fixes: 0f4a9b7d4ecb ("xsk: add FAQ to facilitate for first time users")
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Magnus Karlsson <magnus.karlsson@intel.com>
> Cc: Daniel Borkmann <daniel@iogearbox.net>

Applied, thanks!