Re: [PATCH docs-next v1] docs: Fix bitfield handling in kernel-doc

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

 




On 3/26/24 10:38, Donald Hunter wrote:
> kernel-doc doesn't handle bitfields that are specified with symbolic
> name, e.g. u32 cs_index_mask : SPI_CS_CNT_MAX
> 
> This results in the following warnings when running `make htmldocs`:
> 
> include/linux/spi/spi.h:246: warning: Function parameter or struct member 'cs_index_mask:SPI_CS_CNT_MAX' not described in 'spi_device'
> include/linux/spi/spi.h:246: warning: Excess struct member 'cs_index_mask' description in 'spi_device'
> 
> Update the regexp for bitfields to accept all word chars, not just
> digits.
> 
> Signed-off-by: Donald Hunter <donald.hunter@xxxxxxxxx>


Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Thanks.

That takes care of item #2 on my kernel-doc issues list:
  https://lore.kernel.org/linux-doc/3a6a7dd0-72f1-44c6-b0bc-b1ce76fca76a@xxxxxxxxxxxxx/


> ---
>  scripts/kernel-doc | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> index 967f1abb0edb..cb1be22afc65 100755
> --- a/scripts/kernel-doc
> +++ b/scripts/kernel-doc
> @@ -1541,7 +1541,7 @@ sub create_parameterlist($$$$) {
>                      save_struct_actual($2);
>  
>                      push_parameter($2, "$type $1", $arg, $file, $declaration_name);
> -                } elsif ($param =~ m/(.*?):(\d+)/) {
> +                } elsif ($param =~ m/(.*?):(\w+)/) {
>                      if ($type ne "") { # skip unnamed bit-fields
>                          save_struct_actual($1);
>                          push_parameter($1, "$type:$2", $arg, $file, $declaration_name)

-- 
#Randy




[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