Re: [PATCH] PCI/MSI: api: Use bullet lists in kernel-doc comments

From: Bjorn Helgaas
Date: Mon Nov 21 2022 - 07:34:43 EST


Hi Bagas,

If you have opportunity, please update the subject line to remove
"api: " to match previous history:

PCI/MSI: Correct 'can_mask' test in msi_add_msi_desc()
PCI/MSI: Remove bogus warning in pci_irq_get_affinity()
PCI/MSI: Prevent UAF in error path
PCI/MSI: Unbreak pci_irq_get_affinity()
PCI/MSI: Use msi_on_each_desc()
PCI/MSI: Let core code free MSI descriptors
PCI/MSI: Use msi_add_msi_desc()
PCI/MSI: Protect MSI operations
PCI/MSI: Simplify pci_irq_get_affinity()
...

On Mon, Nov 21, 2022 at 05:12:45PM +0700, Bagas Sanjaya wrote:
> Stephen Rothwell reported htmldocs warnings when merging tip tree:
>
> Documentation/PCI/msi-howto:380: drivers/pci/msi/api.c:148: ERROR: Unexpected indentation.
> Documentation/PCI/msi-howto:380: drivers/pci/msi/api.c:149: WARNING: Block quote ends without a blank line; unexpected unindent.
> Documentation/PCI/msi-howto:380: drivers/pci/msi/api.c:236: ERROR: Unexpected indentation.
> Documentation/PCI/msi-howto:380: drivers/pci/msi/api.c:259: ERROR: Unexpected indentation.
>
> Use bullet lists syntax for pci_disable_msix flags and interrupt mode lists
> to fix these warnings.
>
> Link: https://lore.kernel.org/linux-next/20221121184100.0974cc35@xxxxxxxxxxxxxxxx/
> Fixes: 5c0997dc33ac24 ("PCI/MSI: Move pci_alloc_irq_vectors() to api.c")
> Fixes: 017239c8db2093 ("PCI/MSI: Move pci_irq_vector() to api.c")
> Fixes: be37b8428b7b77 ("PCI/MSI: Move pci_irq_get_affinity() to api.c")
> Reported-by: Stephen Rothwell <sfr@xxxxxxxxxxxxxxxx>
> Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>