]> asedeno.scripts.mit.edu Git - linux.git/commit
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)
commitada5f446bbe504ddf5a374cae65b39108db86867
tree2bc4c134cdccbe4231530a268d7f9fc4b036a51d
parentff58fa7f556c1d87061e4a91ed875d5f8aa9571f
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>
scripts/kernel-doc