lkml.org 
[lkml]   [2023]   [Feb]   [15]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
Date
SubjectRe: [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 <bagasdotme@gmail.com> 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/20230215144505.4751d823@canb.auug.org.au/
> Link: https://lore.kernel.org/linux-doc/202302151123.wUE5FYFx-lkp@intel.com/
> Fixes: c31315c3aa0929 ("bpf, documentation: Add graph documentation for non-owning refs")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
> 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.

\
 
 \ /
  Last update: 2023-03-27 00:24    [W:0.221 / U:0.336 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site