summaryrefslogtreecommitdiffstats
path: root/scripts/kernel-doc
diff options
context:
space:
mode:
authorGabriel Krisman Bertazi <krisman@collabora.co.uk>2017-01-09 18:11:57 -0200
committerJonathan Corbet <corbet@lwn.net>2017-01-13 10:53:24 -0700
commitada5f446bbe504ddf5a374cae65b39108db86867 (patch)
tree2bc4c134cdccbe4231530a268d7f9fc4b036a51d /scripts/kernel-doc
parentff58fa7f556c1d87061e4a91ed875d5f8aa9571f (diff)
downloadlinux-ada5f446bbe504ddf5a374cae65b39108db86867.tar.bz2
kernel-doc: properly document array arguments of function
Documentation for array parameters passed in a function, like the first argument in the function below, weren't getting exported in the rst format, although they work fine for html and pdf formats: void drm_clflush_pages(struct page * pages[], unsigned long num_pages) That's because the string key to store the description in the parameterdescs dictionary doesn't have the [] suffix. This cleans up the suffix from the key before accessing the dictionary. Signed-off-by: Gabriel Krisman Bertazi <krisman@collabora.co.uk> Fixes: c0d1b6ee780a ("kernel-doc: produce RestructuredText output") Reviewed-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'scripts/kernel-doc')
-rwxr-xr-xscripts/kernel-doc2
1 files changed, 1 insertions, 1 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 4c9ada36fe6b..03875d788ea8 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1925,7 +1925,7 @@ sub output_function_rst(%) {
$lineprefix = " ";
foreach $parameter (@{$args{'parameterlist'}}) {
my $parameter_name = $parameter;
- #$parameter_name =~ s/\[.*//;
+ $parameter_name =~ s/\[.*//;
$type = $args{'parametertypes'}{$parameter};
if ($type ne "") {