| Message ID | 20210622185647.3705104-1-i.maximets@ovn.org (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 4b9718b5a201eddcd00d9db6c36b18840125c7ee |
| Delegated to: | BPF |
| Headers | show |
| Series | docs: af_xdp: consistent indentation in examples | expand |
| Context | Check | Description |
|---|---|---|
| netdev/cover_letter | success | Link |
| netdev/fixes_present | success | Link |
| netdev/patch_count | success | Link |
| netdev/tree_selection | success | Guessed tree name to be net-next |
| netdev/subject_prefix | warning | Target tree name not specified in the subject |
| netdev/cc_maintainers | warning | 9 maintainers not CCed: yhs@fb.com kpsingh@kernel.org daniel@iogearbox.net andrii@kernel.org hawk@kernel.org kafai@fb.com ast@kernel.org john.fastabend@gmail.com songliubraving@fb.com |
| netdev/source_inline | success | Was 0 now: 0 |
| netdev/verify_signedoff | success | Link |
| netdev/module_param | success | Was 0 now: 0 |
| netdev/build_32bit | success | Errors and warnings before: 0 this patch: 0 |
| netdev/kdoc | success | Errors and warnings before: 0 this patch: 0 |
| netdev/verify_fixes | success | Link |
| netdev/checkpatch | success | total: 0 errors, 0 warnings, 0 checks, 66 lines checked |
| netdev/build_allmodconfig_warn | success | Errors and warnings before: 0 this patch: 0 |
| netdev/header_inline | success | Link |
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@ovn.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; >
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 >
Hello: This patch was applied to bpf/bpf-next.git (refs/heads/master): On Tue, 22 Jun 2021 20:56:47 +0200 you 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(-) Here is the summary with links: - docs: af_xdp: consistent indentation in examples https://git.kernel.org/bpf/bpf-next/c/4b9718b5a201 You are awesome, thank you! -- Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html
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;
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(-)