Re: [PATCH] docs: af_xdp: consistent indentation in examples

From: Magnus Karlsson <magnus.karlsson@gmail.com>
To: Ilya Maximets <i.maximets@ovn.org>
Cc: "Björn Töpel" <bjorn@kernel.org>,
	"Magnus Karlsson" <magnus.karlsson@intel.com>,
	"Jonathan Lemon" <jonathan.lemon@gmail.com>,
	"David S. Miller" <davem@davemloft.net>,
	"Jakub Kicinski" <kuba@kernel.org>,
	"Jonathan Corbet" <corbet@lwn.net>,
	netdev@vger.kernel.org, bpf@vger.kernel.org,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] docs: af_xdp: consistent indentation in examples
Date: Wed, 23 Jun 2021 08:32:30 +0200	[thread overview]
Message-ID: <CAJ8uoz3Wbfq4C2NeXS6f_1aUk6tb9qRmsKQK7fDyqsgZEXKoSA@mail.gmail.com> (raw)
In-Reply-To: <20210622185647.3705104-1-i.maximets@ovn.org>

On Tue, Jun 22, 2021 at 8:57 PM Ilya Maximets <i.maximets@ovn.org> wrote:
>
> Examples in this document use all kinds of indentation from 3 to 5
> spaces and even mixed with tabs.  Making them all even and equal to
> 4 spaces.
>
> Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
> ---
>  Documentation/networking/af_xdp.rst | 32 ++++++++++++++---------------
>  1 file changed, 16 insertions(+), 16 deletions(-)

Thanks for the cleanup Ilya.

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

> diff --git a/Documentation/networking/af_xdp.rst b/Documentation/networking/af_xdp.rst
> index 2ccc5644cc98..42576880aa4a 100644
> --- a/Documentation/networking/af_xdp.rst
> +++ b/Documentation/networking/af_xdp.rst
> @@ -290,19 +290,19 @@ round-robin example of distributing packets is shown below:
>     #define MAX_SOCKS 16
>
>     struct {
> -        __uint(type, BPF_MAP_TYPE_XSKMAP);
> -        __uint(max_entries, MAX_SOCKS);
> -        __uint(key_size, sizeof(int));
> -        __uint(value_size, sizeof(int));
> +       __uint(type, BPF_MAP_TYPE_XSKMAP);
> +       __uint(max_entries, MAX_SOCKS);
> +       __uint(key_size, sizeof(int));
> +       __uint(value_size, sizeof(int));
>     } xsks_map SEC(".maps");
>
>     static unsigned int rr;
>
>     SEC("xdp_sock") int xdp_sock_prog(struct xdp_md *ctx)
>     {
> -       rr = (rr + 1) & (MAX_SOCKS - 1);
> +       rr = (rr + 1) & (MAX_SOCKS - 1);
>
> -       return bpf_redirect_map(&xsks_map, rr, XDP_DROP);
> +       return bpf_redirect_map(&xsks_map, rr, XDP_DROP);
>     }
>
>  Note, that since there is only a single set of FILL and COMPLETION
> @@ -379,7 +379,7 @@ would look like this for the TX path:
>  .. code-block:: c
>
>     if (xsk_ring_prod__needs_wakeup(&my_tx_ring))
> -      sendto(xsk_socket__fd(xsk_handle), NULL, 0, MSG_DONTWAIT, NULL, 0);
> +       sendto(xsk_socket__fd(xsk_handle), NULL, 0, MSG_DONTWAIT, NULL, 0);
>
>  I.e., only use the syscall if the flag is set.
>
> @@ -442,9 +442,9 @@ purposes. The supported statistics are shown below:
>  .. code-block:: c
>
>     struct xdp_statistics {
> -         __u64 rx_dropped; /* Dropped for reasons other than invalid desc */
> -         __u64 rx_invalid_descs; /* Dropped due to invalid descriptor */
> -         __u64 tx_invalid_descs; /* Dropped due to invalid descriptor */
> +       __u64 rx_dropped; /* Dropped for reasons other than invalid desc */
> +       __u64 rx_invalid_descs; /* Dropped due to invalid descriptor */
> +       __u64 tx_invalid_descs; /* Dropped due to invalid descriptor */
>     };
>
>  XDP_OPTIONS getsockopt
> @@ -483,15 +483,15 @@ like this:
>  .. code-block:: c
>
>      // struct xdp_rxtx_ring {
> -    //         __u32 *producer;
> -    //         __u32 *consumer;
> -    //         struct xdp_desc *desc;
> +    //     __u32 *producer;
> +    //     __u32 *consumer;
> +    //     struct xdp_desc *desc;
>      // };
>
>      // struct xdp_umem_ring {
> -    //         __u32 *producer;
> -    //         __u32 *consumer;
> -    //         __u64 *desc;
> +    //     __u32 *producer;
> +    //     __u32 *consumer;
> +    //     __u64 *desc;
>      // };
>
>      // typedef struct xdp_rxtx_ring RING;
> --
> 2.26.3
>