linux-kernel - Re: [PATCH] docs: af_xdp: consistent indentation in examples

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <b871fd9c-897c-26ca-f4fd-7d81b3489379@ovn.org>
Date:   Tue, 22 Jun 2021 21:07:51 +0200
From:   Ilya Maximets <i.maximets@....org>
To:     Ilya Maximets <i.maximets@....org>,
        Björn Töpel <bjorn@...nel.org>
Cc:     Magnus Karlsson <magnus.karlsson@...el.com>,
        Jonathan Lemon <jonathan.lemon@...il.com>,
        "David S. Miller" <davem@...emloft.net>,
        Jakub Kicinski <kuba@...nel.org>,
        Jonathan Corbet <corbet@....net>, netdev@...r.kernel.org,
        bpf@...r.kernel.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] docs: af_xdp: consistent indentation in examples

On 6/22/21 8:56 PM, Ilya Maximets 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@....org>
> ---

Ugh.  Sorry, meant to send for bpf-next, but lost the subject prefix
somewhere...  Can re-send if needed.

>  Documentation/networking/af_xdp.rst | 32 ++++++++++++++---------------
>  1 file changed, 16 insertions(+), 16 deletions(-)
> 
> 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;
>