scripts/kernel-doc: Add missing close-paren in c:function directives
authorPeter Maydell <peter.maydell@linaro.org>
Tue, 14 Apr 2020 14:37:43 +0000 (15:37 +0100)
committerJonathan Corbet <corbet@lwn.net>
Wed, 15 Apr 2020 20:58:12 +0000 (14:58 -0600)
commite8f4ba833166d4f589ab80630709e807a09f0b43
tree574f3d82f8b52fd376d57adba6bdd97992454eed
parent52338dfb3ca11e6a99288e9e9e4019f279822ddd
scripts/kernel-doc: Add missing close-paren in c:function directives

When kernel-doc generates a 'c:function' directive for a function
one of whose arguments is a function pointer, it fails to print
the close-paren after the argument list of the function pointer
argument. For instance:

 long work_on_cpu(int cpu, long (*fn) (void *, void * arg)

in driver-api/basics.html is missing a ')' separating the
"void *" of the 'fn' arguments from the ", void * arg" which
is an argument to work_on_cpu().

Add the missing close-paren, so that we render the prototype
correctly:

 long work_on_cpu(int cpu, long (*fn)(void *), void * arg)

(Note that Sphinx stops rendering a space between the '(fn*)' and the
'(void *)' once it gets something that's syntactically valid.)

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Link: https://lore.kernel.org/r/20200414143743.32677-1-peter.maydell@linaro.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
scripts/kernel-doc