Searched hist:"9 f2b463ad8beb76acaf3f5d1654b660592760e68" (Results 1 – 1 of 1) sorted by relevance
/openbmc/qemu/scripts/ |
H A D | kernel-doc | 9f2b463ad8beb76acaf3f5d1654b660592760e68 Tue Nov 17 10:52:49 CST 2020 Mauro Carvalho Chehab <mchehab+huawei@kernel.org> 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> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> Message-Id: <20201117165312.118257-7-pbonzini@redhat.com> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
|