Skip to content

Commit

Permalink
bpf, docs: Fix __uninit kfunc doc section
Browse files Browse the repository at this point in the history
In commit d96d937 ("bpf: Add __uninit kfunc annotation"), the
__uninit kfunc annotation was documented in kfuncs.rst. You have to
fully underline a section in rst, or the build will issue a warning that
the title underline is too short:

./Documentation/bpf/kfuncs.rst:104: WARNING: Title underline too short.

2.2.2 __uninit Annotation
--------------------

This patch fixes that title underline.

Fixes: d96d937 ("bpf: Add __uninit kfunc annotation")
Signed-off-by: David Vernet <void@manifault.com>
Link: https://lore.kernel.org/r/20230301194910.602738-2-void@manifault.com
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
  • Loading branch information
David Vernet authored and Alexei Starovoitov committed Mar 2, 2023
1 parent 7ce60b1 commit db52b58
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Documentation/bpf/kfuncs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ size parameter, and the value of the constant matters for program safety, __k
suffix should be used.

2.2.2 __uninit Annotation
--------------------
-------------------------

This annotation is used to indicate that the argument will be treated as
uninitialized.
Expand Down

0 comments on commit db52b58

Please sign in to comment.