Re: [PATCH] kernel-doc: properly document array arguments of function

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Mon,  9 Jan 2017 18:11:57 -0200
Gabriel Krisman Bertazi <krisman@xxxxxxxxxxxxxxx> 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 <krisman@xxxxxxxxxxxxxxx>
> ---
>  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};

So surely I had some good reason for commenting that line way back when,
but I certainly don't remember it now.  Applied to the docs tree, thanks.

jon
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux