PCI/MSI: Use bullet lists in kernel-doc comments of api.c
Subsystems (3)
PATCH v2 1/1 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.
[[email protected]: For C kernel-doc comments legibility, keep
the flags and interrupt mode descriptions aligned.]
---
Changes since v1 [1]:
* Slightly adjust patch subject to match other subsystem commits.
* Add SoB from Ahmed S. Darwish due to applying his suggestions (is Co-developed-by: trailer more appropriate in this case?).
[1]: https://lore.kernel.org/lkml/[email protected]/
drivers/pci/msi/api.c | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-)
drivers/pci/msi/api.c +19 -14
@@ -142,12 +142,15 @@ 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 -* and only if @min_vecs == 1 -* %PCI_IRQ_AFFINITY Auto-manage IRQs affinity by spreading -* the vectors around available CPUs +* +* * %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 +* the vectors around available CPUs * * Allocate up to @max_vecs interrupt vectors on device. MSI-X irq * vector allocation has a higher precedence over plain MSI, which has a
@@ -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
base-commit: 3170a767052ac5432547a2d8c9d4753d82b45f38
Signature · 1 line
An old man doll... just what I always wanted! - Clara
The following commit has been merged into the irq/core branch of tip:
The following commit has been merged into the irq/core branch of tip:
Commit-ID: 6842694c5088925d216529d4a2358ab5ee8bb862 Gitweb: https://git.kernel.org/tip/6842694c5088925d216529d4a2358ab5ee8bb862 Author: Bagas Sanjaya <[email protected]> AuthorDate: Sat, 03 Dec 2022 17:05:11 +07:00 Committer: Thomas Gleixner <[email protected]> CommitterDate: Mon, 05 Dec 2022 18:57:46 +01:00
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.
--- drivers/pci/msi/api.c | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-)
drivers/pci/msi/api.c +19 -14
@@ -142,12 +142,15 @@ 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 -* and only if @min_vecs == 1 -* %PCI_IRQ_AFFINITY Auto-manage IRQs affinity by spreading -* the vectors around available CPUs +* +* * %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 +* the vectors around available CPUs * * Allocate up to @max_vecs interrupt vectors on device. MSI-X irq * vector allocation has a higher precedence over plain MSI, which has a
@@ -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