Skip to content

Commit

Permalink
Documentation: bpf: Add missing line break separator in node_data str…
Browse files Browse the repository at this point in the history
…uct 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/20230215144505.4751d823@canb.auug.org.au/
Link: https://lore.kernel.org/linux-doc/202302151123.wUE5FYFx-lkp@intel.com/
Fixes: c31315c ("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>
Link: https://lore.kernel.org/r/20230215123253.41552-3-bagasdotme@gmail.com
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
  • Loading branch information
Bagas Sanjaya authored and Alexei Starovoitov committed Feb 15, 2023
1 parent 1f5dfcc commit e2d323a
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions Documentation/bpf/graph_ds_impl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit e2d323a

Please sign in to comment.