lkml.org 
[lkml]   [2022]   [Nov]   [21]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    Date
    From
    SubjectRe: [PATCH] PCI/MSI: api: Use bullet lists in kernel-doc comments
    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.

    --
    An old man doll... just what I always wanted! - Clara
    [unhandled content-type:application/pgp-signature]
    \
     
     \ /
      Last update: 2022-11-22 04:45    [W:3.230 / U:0.080 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site