[2/3] Documentation: bpf: Add missing line break separator in node_data struct code block

Commit Message

Bagas Sanjaya Feb. 15, 2023, 12:32 p.m. UTC

Stephen Rothwell reported htmldocs warning when merging bpf-next tree,
which was the same warning as reported by kernel test robot:

Documentation/bpf/graph_ds_impl.rst:62: ERROR: Error in "code-block" directive:
maximum 1 argument(s) allowed, 12 supplied.

The error is due to Sphinx confuses node_data struct declaration with
code-block directive option.

Fix the warning by separating the code-block marker with node_data struct
declaration.

Link: https://lore.kernel.org/linux-next/[e-mail]/
Link: https://lore.kernel.org/linux-doc/[e-mail]/
Fixes: c31315c3aa0929 ("bpf, documentation: Add graph documentation for non-owning refs")
Reported-by: Stephen Rothwell <[e-mail]>
Reported-by: kernel test robot <[e-mail]>
Signed-off-by: Bagas Sanjaya <[e-mail]>
---
 Documentation/bpf/graph_ds_impl.rst | 1 +
 1 file changed, 1 insertion(+)

Comments

Alexei Starovoitov Feb. 15, 2023, 4:46 p.m. UTC | #1

On Wed, Feb 15, 2023 at 4:33 AM Bagas Sanjaya <[e-mail]> wrote:
>
> Stephen Rothwell reported htmldocs warning when merging bpf-next tree,
> which was the same warning as reported by kernel test robot:
>
> Documentation/bpf/graph_ds_impl.rst:62: ERROR: Error in "code-block" directive:
> maximum 1 argument(s) allowed, 12 supplied.
>
> The error is due to Sphinx confuses node_data struct declaration with
> code-block directive option.
>
> Fix the warning by separating the code-block marker with node_data struct
> declaration.
>
> Link: https://lore.kernel.org/linux-next/[e-mail]/
> Link: https://lore.kernel.org/linux-doc/[e-mail]/
> Fixes: c31315c3aa0929 ("bpf, documentation: Add graph documentation for non-owning refs")
> Reported-by: Stephen Rothwell <[e-mail]>
> Reported-by: kernel test robot <[e-mail]>
> Signed-off-by: Bagas Sanjaya <[e-mail]>
> ---
>  Documentation/bpf/graph_ds_impl.rst | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/Documentation/bpf/graph_ds_impl.rst b/Documentation/bpf/graph_ds_impl.rst
> index 8bbf1815efe784..61274622b71d85 100644
> --- a/Documentation/bpf/graph_ds_impl.rst
> +++ b/Documentation/bpf/graph_ds_impl.rst
> @@ -60,6 +60,7 @@ The new-style data structures are intrusive and are defined similarly to their
>  vanilla kernel counterparts:
>
>  .. code-block:: c
> +
>          struct node_data {

Applied to bpf-next.

Patch

diff --git a/Documentation/bpf/graph_ds_impl.rst b/Documentation/bpf/graph_ds_impl.rst
index 8bbf1815efe784..61274622b71d85 100644
--- a/Documentation/bpf/graph_ds_impl.rst
+++ b/Documentation/bpf/graph_ds_impl.rst
@@ -60,6 +60,7 @@  The new-style data structures are intrusive and are defined similarly to their
 vanilla kernel counterparts:
 
 .. code-block:: c
+
         struct node_data {
           long key;
           long data;