From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5F097C433FE for ; Tue, 22 Nov 2022 05:57:22 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232151AbiKVF5V (ORCPT ); Tue, 22 Nov 2022 00:57:21 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:52772 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232108AbiKVF4h (ORCPT ); Tue, 22 Nov 2022 00:56:37 -0500 Received: from galois.linutronix.de (Galois.linutronix.de [IPv6:2a0a:51c0:0:12e:550::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 79D462EF00; Mon, 21 Nov 2022 21:56:35 -0800 (PST) Date: Tue, 22 Nov 2022 06:56:31 +0100 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020; t=1669096593; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=QNTsxF40xWKZoDBnjmTlY9Dq7N5CAn/b84v7kd9HJBs=; b=cpGj0Q2ad8aMqVKTFWYLQYwfkPzgOa1KStujrZj32eBOhpAMRTc6PWKI7RLGXhB7ICjMhZ xRj28bG+MnmgBcURxgIc21H+YbZaJJ54SVKAd4ibNRu0obVS/LZcTkqPE4IwOleSJLKkVo e9wYSQNI+9C4IK6z9NVq6dZA1sQemWu9SUFQFfIxglMQJ9MhchKjulzziMIDa637ZFbcby 1skN+bB2gWx7jSSHjKk1KzL1JOV7Mig0WsAHlMD2hRFgKNha7uvVFz/nCVrMzogkIxhYjc wOSR4gp/nyjDRdiLbdcnow7xaJE4x57KJZSUA5S5C1OkKWi1hYXCFHrMidJqrQ== DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020e; t=1669096593; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=QNTsxF40xWKZoDBnjmTlY9Dq7N5CAn/b84v7kd9HJBs=; b=WabF+tyHdg/1qLX6L+dAL0z3d6L4v5CfWJ/MZuSx5MTUt+zYE+Zhwg36VJbNUIIlhCIvgd r83qiB76K9H6RuCw== From: "Ahmed S. Darwish" To: Bagas Sanjaya Cc: linux-pci@vger.kernel.org, linux-kernel@vger.kernel.org, linux-next@vger.kernel.org, linux-doc@vger.kernel.org, Bjorn Helgaas , Thomas Gleixner , Stephen Rothwell Subject: Re: [PATCH] PCI/MSI: api: Use bullet lists in kernel-doc comments Message-ID: References: <20221121184100.0974cc35@canb.auug.org.au> <20221121101245.23544-1-bagasdotme@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 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 Signed-off-by: Bagas Sanjaya [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 --- 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