diff options
author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-04-14 19:48:29 +0300 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2020-04-21 00:35:58 +0300 |
commit | 0d55d48b19ff3a31b295836da23223a52de7ef06 (patch) | |
tree | 90089c643015d19efe6d5de557c184731b09402a /Documentation/sphinx | |
parent | ee2aa7590398ecc0877552191e38d8a282f21cb8 (diff) | |
download | linux-0d55d48b19ff3a31b295836da23223a52de7ef06.tar.xz |
scripts: kernel-doc: accept blank lines on parameter description
Sphinx is very pedantic with respect to blank lines. Sometimes,
in order to make it to properly handle something, we need to
add a blank line. However, currently, any blank line inside a
kernel-doc comment like:
/*
* @foo: bar
*
* foobar
*
* some description
will be considered as if "foobar" was part of the description.
This patch changes kernel-doc behavior. After it, foobar will
be considered as part of the parameter text. The description
will only be considered as such if it starts with:
zero spaces after asterisk:
*foo
one space after asterisk:
* foo
or have a explicit Description section:
* Description:
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/c07d2862792d75a2691d69c9eceb7b89a0164cc0.1586881715.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/sphinx')
0 files changed, 0 insertions, 0 deletions