[PATCH v2] PCI: iproc: Fix a non-compliant kernel-doc

Krzysztof Wilczyński kw at linux.com
Wed May 19 15:49:08 PDT 2021


Hi,

> This is a really good cleanup, but there is still one kernel-doc
> warning remaining after this patch is applied. Please see below.
[...]
> > - * iProc PCIe inbound mapping type
> > + * enum iproc_pcie_ib_map_type - iProc PCIe inbound mapping type.
[...]
> 
> The above gives me this:
> 
> pcie-iproc.c:151: warning: Enum value 'IPROC_PCIE_IB_MAP_MEM' not described in enum 'iproc_pcie_ib_map_type'
> pcie-iproc.c:151: warning: Enum value 'IPROC_PCIE_IB_MAP_IO' not described in enum 'iproc_pcie_ib_map_type'
> pcie-iproc.c:151: warning: Enum value 'IPROC_PCIE_IB_MAP_INVALID' not described in enum 'iproc_pcie_ib_map_type'
> 
> 
> If you could fix that, it would be Nice. :)
> 
> Even if not, it's a good cleanup. Thanks.

Doh!  Apologies!  This is my bad - correcting the format of the
kernel-doc made the parser go and check for the fields to be properly
documented, thus this new warning.  I need to also take care about this
too, a very good point!

Thank you for catching this!  I will update everything accordingly.

Krzysztof



More information about the linux-arm-kernel mailing list