]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit - scripts/kernel-doc
scripts: kernel-doc: accept blank lines on parameter description
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 14 Apr 2020 16:48:29 +0000 (18:48 +0200)
committerJonathan Corbet <corbet@lwn.net>
Mon, 20 Apr 2020 21:35:58 +0000 (15:35 -0600)
commit0d55d48b19ff3a31b295836da23223a52de7ef06
tree90089c643015d19efe6d5de557c184731b09402a
parentee2aa7590398ecc0877552191e38d8a282f21cb8
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>
scripts/kernel-doc