From: Bagas Sanjaya <bagasdotme@gmail.com>
To: "Ahmed S. Darwish" <darwi@linutronix.de>
Cc: linux-pci@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-next@vger.kernel.org, linux-doc@vger.kernel.org,
Bjorn Helgaas <bhelgaas@google.com>,
Thomas Gleixner <tglx@linutronix.de>,
Stephen Rothwell <sfr@canb.auug.org.au>
Subject: Re: [PATCH] PCI/MSI: api: Use bullet lists in kernel-doc comments
Date: Tue, 22 Nov 2022 10:43:19 +0700 [thread overview]
Message-ID: <Y3xFV2IkUlRWPdCd@debian.me> (raw)
In-Reply-To: <Y3t83uo/TZzxc1nL@lx-t490>
[-- Attachment #1: Type: text/plain, Size: 3368 bytes --]
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
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
next prev parent reply other threads:[~2022-11-22 3:43 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-21 7:41 linux-next: build warnings after merge of the tip tree Stephen Rothwell
2022-11-21 10:12 ` [PATCH] PCI/MSI: api: Use bullet lists in kernel-doc comments Bagas Sanjaya
2022-11-21 12:34 ` Bjorn Helgaas
2022-11-22 3:44 ` Bagas Sanjaya
2022-11-21 13:27 ` Ahmed S. Darwish
2022-11-22 3:43 ` Bagas Sanjaya [this message]
2022-11-22 5:56 ` Ahmed S. Darwish
2022-11-22 8:11 ` Bagas Sanjaya
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=Y3xFV2IkUlRWPdCd@debian.me \
--to=bagasdotme@gmail.com \
--cc=bhelgaas@google.com \
--cc=darwi@linutronix.de \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=linux-pci@vger.kernel.org \
--cc=sfr@canb.auug.org.au \
--cc=tglx@linutronix.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).