| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Message-ID: <167026472230.4906.11758765575480144436.tip-bot2@tip-bot2>
Date: Mon, 05 Dec 2022 18:25:22 -0000
From: "tip-bot2 for Bagas Sanjaya" <tip-bot2@...utronix.de>
To: linux-tip-commits@...r.kernel.org
Cc: Stephen Rothwell <sfr@...b.auug.org.au>,
"Ahmed S. Darwish" <darwi@...utronix.de>,
Bagas Sanjaya <bagasdotme@...il.com>,
Thomas Gleixner <tglx@...utronix.de>, x86@...nel.org,
linux-kernel@...r.kernel.org, maz@...nel.org
Subject: [tip: irq/core] PCI/MSI: Use bullet lists in kernel-doc comments of api.c
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 <bagasdotme@...il.com>
AuthorDate: Sat, 03 Dec 2022 17:05:11 +07:00
Committer: Thomas Gleixner <tglx@...utronix.de>
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.
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@...b.auug.org.au>
Suggested-by: Ahmed S. Darwish <darwi@...utronix.de>
Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
Signed-off-by: Thomas Gleixner <tglx@...utronix.de>
Acked-by: Ahmed S. Darwish <darwi@...utronix.de>
Link: https://lore.kernel.org/r/20221203100511.222136-1-bagasdotme@gmail.com
---
drivers/pci/msi/api.c | 33 +++++++++++++++++++--------------
1 file changed, 19 insertions(+), 14 deletions(-)
diff --git a/drivers/pci/msi/api.c b/drivers/pci/msi/api.c
index 6c3ad48..2d46a0c 100644
--- a/drivers/pci/msi/api.c
+++ b/drivers/pci/msi/api.c
@@ -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
Powered by blists - more mailing lists