Commit 6842694c authored by Bagas Sanjaya's avatar Bagas Sanjaya Committed by Thomas Gleixner
Browse files

PCI/MSI: Use bullet lists in kernel-doc comments of api.c 



Use bullet-list RST syntax for kernel-doc parameters' flags and interrupt
mode descriptions. Otherwise Sphinx produces "Unexpected identation" errors
and warnings.

Fixes: 5c0997dc ("PCI/MSI: Move pci_alloc_irq_vectors() to api.c")
Fixes: 017239c8 ("PCI/MSI: Move pci_irq_vector() to api.c")
Fixes: be37b842 ("PCI/MSI: Move pci_irq_get_affinity() to api.c")
Reported-by: default avatarStephen Rothwell <sfr@canb.auug.org.au>
Suggested-by: default avatarAhmed S. Darwish <darwi@linutronix.de>
Signed-off-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: default avatarThomas Gleixner <tglx@linutronix.de>
Acked-by: default avatarAhmed S. Darwish <darwi@linutronix.de>
Link: https://lore.kernel.org/r/20221203100511.222136-1-bagasdotme@gmail.com
parent 9049e1ca

drivers/pci/msi/api.c

+19 −14
Original line number Diff line number Diff line
@@ -142,11 +142,14 @@ EXPORT_SYMBOL(pci_disable_msix); 
 * @min_vecs: minimum required number of vectors (must be >= 1)

 * @max_vecs: maximum desired number of vectors

 * @flags:    One or more of:

 *            %PCI_IRQ_MSIX      Allow trying MSI-X vector allocations

 *            %PCI_IRQ_MSI       Allow trying MSI vector allocations

 *            %PCI_IRQ_LEGACY    Allow trying legacy INTx interrupts, if

 *

 *            * %PCI_IRQ_MSIX      Allow trying MSI-X vector allocations

 *            * %PCI_IRQ_MSI       Allow trying MSI vector allocations

 *

 *            * %PCI_IRQ_LEGACY    Allow trying legacy INTx interrupts, if

 *              and only if @min_vecs == 1

 *            %PCI_IRQ_AFFINITY  Auto-manage IRQs affinity by spreading

 *

 *            * %PCI_IRQ_AFFINITY  Auto-manage IRQs affinity by spreading

 *              the vectors around available CPUs

 *

 * Allocate up to @max_vecs interrupt vectors on device. MSI-X irq
@@ -232,10 +235,11 @@ EXPORT_SYMBOL(pci_alloc_irq_vectors_affinity); 
 * pci_irq_vector() - Get Linux IRQ number of a device interrupt vector

 * @dev: the PCI device to operate on

 * @nr:  device-relative interrupt vector index (0-based); has different

 *       meanings, depending on interrupt mode

 *         MSI-X        the index in the MSI-X vector table

 *         MSI          the index of the enabled MSI vectors

 *         INTx         must be 0

 *       meanings, depending on interrupt mode:

 *

 *         * MSI-X     the index in the MSI-X vector table

 *         * MSI       the index of the enabled MSI vectors

 *         * INTx      must be 0

 *

 * Return: the Linux IRQ number, or -EINVAL if @nr is out of range

 */
@@ -255,10 +259,11 @@ EXPORT_SYMBOL(pci_irq_vector); 
 * pci_irq_get_affinity() - Get a device interrupt vector affinity

 * @dev: the PCI device to operate on

 * @nr:  device-relative interrupt vector index (0-based); has different

 *       meanings, depending on interrupt mode

 *         MSI-X        the index in the MSI-X vector table

 *         MSI          the index of the enabled MSI vectors

 *         INTx         must be 0

 *       meanings, depending on interrupt mode:

 *

 *         * MSI-X     the index in the MSI-X vector table

 *         * MSI       the index of the enabled MSI vectors

 *         * INTx      must be 0

 *

 * Return: MSI/MSI-X vector affinity, NULL if @nr is out of range or if

 * the MSI(-X) vector was allocated without explicit affinity