diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2020-11-17 17:52:49 +0100 |
|---|---|---|
| committer | Paolo Bonzini <pbonzini@redhat.com> | 2020-12-10 12:15:20 -0500 |
| commit | 9f2b463ad8beb76acaf3f5d1654b660592760e68 (patch) | |
| tree | 80962609fd0cd0bb3e05ede7f0e34d7625ba7e20 /scripts/qemu-gdb.py | |
| parent | b1e8e720b649ad1b7275d7eeef841c2528a63fe1 (diff) | |
| download | focaccia-qemu-9f2b463ad8beb76acaf3f5d1654b660592760e68.tar.gz focaccia-qemu-9f2b463ad8beb76acaf3f5d1654b660592760e68.zip | |
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>
Diffstat (limited to 'scripts/qemu-gdb.py')
0 files changed, 0 insertions, 0 deletions