summary refs log tree commit diff
path: root/Documentation/CodingStyle
diff options
context:
space:
mode:
authorAditya Srivastava <yashsri421@gmail.com>2021-02-17 20:26:25 +0530
committerJonathan Corbet <corbet@lwn.net>2021-02-22 14:20:36 -0700
commit336ced2de62d27b5a1d64672d7470e0cc7f93376 (patch)
tree5797b1f963755d7cff184233e0ae7e701a26dd8a /Documentation/CodingStyle
parent163ba35ff3714d7ccb57f7e4bc2bb44365c343a0 (diff)
downloadlinux-336ced2de62d27b5a1d64672d7470e0cc7f93376.tar.gz
scripts: kernel-doc: fix array element capture in pointer-to-func parsing
Currently, kernel-doc causes an unexpected error when array element (i.e.,
"type (*foo[bar])(args)") is present as pointer parameter in
pointer-to-function parsing.

For e.g., running kernel-doc -none on kernel/gcov/gcc_4_7.c causes this
error:
"Use of uninitialized value $param in regexp compilation at ...", in
combination with:
"warning: Function parameter or member '' not described in 'gcov_info'"

Here, the parameter parsing does not take into account the presence of
array element (i.e. square brackets) in $param.

Provide a simple fix by adding square brackets in the regex, responsible
for capturing $param.

A quick evaluation, by running 'kernel-doc -none' on entire kernel-tree,
reveals that no additional warning or error has been added or removed by
the fix.

Suggested-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
Tested-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Link: https://lore.kernel.org/r/20210217145625.14006-1-yashsri421@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/CodingStyle')
0 files changed, 0 insertions, 0 deletions