2023-02-15 12:33:14

by Bagas Sanjaya

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

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/[email protected]/
Link: https://lore.kernel.org/linux-doc/[email protected]/
Fixes: c31315c3aa0929 ("bpf, documentation: Add graph documentation for non-owning refs")
Reported-by: Stephen Rothwell <[email protected]>
Reported-by: kernel test robot <[email protected]>
Signed-off-by: Bagas Sanjaya <[email protected]>
---
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 {
long key;
long data;
--
An old man doll... just what I always wanted! - Clara

2023-02-15 16:46:32

by Alexei Starovoitov

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

On Wed, Feb 15, 2023 at 4:33 AM Bagas Sanjaya <[email protected]> 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/[email protected]/
> Link: https://lore.kernel.org/linux-doc/[email protected]/
> Fixes: c31315c3aa0929 ("bpf, documentation: Add graph documentation for non-owning refs")
> Reported-by: Stephen Rothwell <[email protected]>
> Reported-by: kernel test robot <[email protected]>
> Signed-off-by: Bagas Sanjaya <[email protected]>
> ---
> 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.