From: "Ahmed S. Darwish" <darwi@linutronix.de>
To: Bagas Sanjaya <bagasdotme@gmail.com>
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: Mon, 21 Nov 2022 14:27:58 +0100 [thread overview]
Message-ID: <Y3t83uo/TZzxc1nL@lx-t490> (raw)
In-Reply-To: <20221121101245.23544-1-bagasdotme@gmail.com>
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
next prev parent reply other threads:[~2022-11-21 13:29 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 [this message]
2022-11-22 3:43 ` Bagas Sanjaya
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=Y3t83uo/TZzxc1nL@lx-t490 \
--to=darwi@linutronix.de \
--cc=bagasdotme@gmail.com \
--cc=bhelgaas@google.com \
--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).