diff mbox series

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

Message ID	20221121101245.23544-1-bagasdotme@gmail.com
State	New
Headers	Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; From: Bagas Sanjaya <bagasdotme@gmail.com> To: linux-pci@vger.kernel.org, linux-kernel@vger.kernel.org, linux-next@vger.kernel.org, linux-doc@vger.kernel.org Cc: Bjorn Helgaas <bhelgaas@google.com>, Thomas Gleixner <tglx@linutronix.de>, "Ahmed S. Darwish" <darwi@linutronix.de>, Bagas Sanjaya <bagasdotme@gmail.com>, Stephen Rothwell <sfr@canb.auug.org.au> Subject: [PATCH] PCI/MSI: api: Use bullet lists in kernel-doc comments Date: Mon, 21 Nov 2022 17:12:45 +0700 Message-Id: <20221121101245.23544-1-bagasdotme@gmail.com> In-Reply-To: <20221121184100.0974cc35@canb.auug.org.au> References: <20221121184100.0974cc35@canb.auug.org.au> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk
Series	PCI/MSI: api: Use bullet lists in kernel-doc comments \| PCI/MSI: api: Use bullet lists in kernel-doc comments

Commit Message

Bagas Sanjaya Nov. 21, 2022, 10:12 a.m. UTC

  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@canb.auug.org.au/
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@canb.auug.org.au>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 drivers/pci/msi/api.c | 33 +++++++++++++++++++--------------
 1 file changed, 19 insertions(+), 14 deletions(-)


base-commit: 15ce088a8698c22cf5a18799dda16f04ed1d1cb7

Comments

Bjorn Helgaas Nov. 21, 2022, 12:34 p.m. UTC | #1

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@canb.auug.org.au/
> 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@canb.auug.org.au>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Ahmed S. Darwish Nov. 21, 2022, 1:27 p.m. UTC | #2

On Mon, Nov 21, 2022 at 05:12:45PM +0700, Bagas Sanjaya wrote:
>   * @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
...
> - *       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

Sorry for the trouble.

While at it, can we please keep the alignment in the original patch?
This is supposed to be pretty too for people who look at the C code
(most of the actual readers).

That is:

 + *
 + *            * %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

and:

> + *       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

Thanks,

--
Ahmed S. Darwish
Linutronix GmbH

Bagas Sanjaya Nov. 22, 2022, 3:43 a.m. UTC | #3

On Mon, Nov 21, 2022 at 02:27:58PM +0100, Ahmed S. Darwish wrote:
> Sorry for the trouble.
> 
> While at it, can we please keep the alignment in the original patch?
> This is supposed to be pretty too for people who look at the C code
> (most of the actual readers).
> 
> That is:
> 
>  + *
>  + *            * %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
> 

For the list above, no, since if the alignment is kept, like:

---- >8 ----

diff --git a/drivers/pci/msi/api.c b/drivers/pci/msi/api.c
index d48c21295a88c6..13f612bbbb29b2 100644
--- a/drivers/pci/msi/api.c
+++ b/drivers/pci/msi/api.c
@@ -143,14 +143,14 @@ EXPORT_SYMBOL(pci_disable_msix);
  * @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_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_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
+ *                                  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
@@ -238,8 +238,8 @@ EXPORT_SYMBOL(pci_alloc_irq_vectors_affinity);
  *       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
+ *         * 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
  */
@@ -262,8 +262,8 @@ EXPORT_SYMBOL(pci_irq_vector);
  *       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
+ *         * 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

, multi-line entries will be rendered as definition list instead. So, these
entries must have hanging indent of two spaces after bullet marker (*),
following alignment of first line of the entry.

Also, these entries must be separated from other entries by a line, otherwise
the list will be broken (rendered inline).

Thanks.

Bagas Sanjaya Nov. 22, 2022, 3:44 a.m. UTC | #4

On Mon, Nov 21, 2022 at 06:34:02AM -0600, Bjorn Helgaas wrote:
> 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()
>   ...

OK, thanks.

Ahmed S. Darwish Nov. 22, 2022, 5:56 a.m. UTC | #5

On Tue, Nov 22, 2022 at 10:43:19AM +0700, Bagas Sanjaya wrote:
>
> For the list above, no, since if the alignment is kept, like:
>

NAK.

Below patch works properly on my side, no Sphinx errors and proper HTML
view, while still keeping proper-alignment in the C code.

Sorry, you're too focusing on the HTML side.

Making the C code readable, not just the HTML output, is quite
important.

=>

From: Bagas Sanjaya <bagasdotme@gmail.com>

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

Link: https://lore.kernel.org/r/20221121101245.23544-1-bagasdotme@gmail.com
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@canb.auug.org.au>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
[darwi@linutronix.de: Match subject-line with other subystem commits]
[darwi@linutronix.de: Remove verbose Sphinx log from commit log]
[darwi@linutronix.de: For C kernel-doc comments legibility, keep
 the flags and interrupt mode descriptions aligned.]
Acked-by: Ahmed S. Darwish <darwi@linutronix.de>
---

 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 dfcaa77108de..6c0c0f3ad3b8 100644
--- a/drivers/pci/msi/api.c
+++ b/drivers/pci/msi/api.c
@@ -209,12 +209,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
@@ -299,10 +302,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
  */
@@ -322,10 +326,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
--
2.38.1

Bagas Sanjaya Nov. 22, 2022, 8:11 a.m. UTC | #6

On 11/22/22 12:56, Ahmed S. Darwish wrote:
> On Tue, Nov 22, 2022 at 10:43:19AM +0700, Bagas Sanjaya wrote:
>>
>> For the list above, no, since if the alignment is kept, like:
>>
> 
> NAK.
> 
> Below patch works properly on my side, no Sphinx errors and proper HTML
> view, while still keeping proper-alignment in the C code.
> 
> Sorry, you're too focusing on the HTML side.
> 
> Making the C code readable, not just the HTML output, is quite
> important.
> 
> =>
> 
> From: Bagas Sanjaya <bagasdotme@gmail.com>
> 
> Use bullet-list RST syntax for kernel-doc parameters' flags and
> interrupt mode descriptions. Otherwise Sphinx produces "Unexpected
> identation" errors and warnings.
> 
> Link: https://lore.kernel.org/r/20221121101245.23544-1-bagasdotme@gmail.com
> 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@canb.auug.org.au>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> [darwi@linutronix.de: Match subject-line with other subystem commits]
> [darwi@linutronix.de: Remove verbose Sphinx log from commit log]
> [darwi@linutronix.de: For C kernel-doc comments legibility, keep
>  the flags and interrupt mode descriptions aligned.]
> Acked-by: Ahmed S. Darwish <darwi@linutronix.de>
> ---
> 
>  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 dfcaa77108de..6c0c0f3ad3b8 100644
> --- a/drivers/pci/msi/api.c
> +++ b/drivers/pci/msi/api.c
> @@ -209,12 +209,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
> @@ -299,10 +302,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
>   */
> @@ -322,10 +326,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

Personally I'd like to write the entries as:

  * term - definition

But anyway, your suggestion patch LGTM. Thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

diff mbox series

Patch

diff --git a/drivers/pci/msi/api.c b/drivers/pci/msi/api.c
index 6c3ad4863850c3..d48c21295a88c6 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