kernel-doc: properly document array arguments of function
authorGabriel Krisman Bertazi <krisman@collabora.co.uk>
Mon, 9 Jan 2017 20:11:57 +0000 (18:11 -0200)
committerJonathan Corbet <corbet@lwn.net>
Fri, 13 Jan 2017 17:53:24 +0000 (10:53 -0700)
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>
scripts/kernel-doc

index 4c9ada36fe6b9ea6562900fc8bd9537a9121498b..03875d788ea8e4146c5a95acb0a398a291acc7f5 100755 (executable)
@@ -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 "") {