On Mon, 09 Jan 2017, Gabriel Krisman Bertazi <[email protected]> wrote:
> 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 <[email protected]>
Fixes: c0d1b6ee780a ("kernel-doc: produce RestructuredText output")
Reviewed-by: Jani Nikula <[email protected]>
> ---
> scripts/kernel-doc | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> index 030fc633acd4..0cd3b8461860 100755
> --- a/scripts/kernel-doc
> +++ b/scripts/kernel-doc
> @@ -1883,7 +1883,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 "") {
--
Jani Nikula, Intel Open Source Technology Center
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
