Re: [PATCH v2 09/19] irqdomain: Add missing parameter descriptions in docs

From: Herve Codina <herve.codina@bootlin.com>
To: Andy Shevchenko <andy.shevchenko@gmail.com>
Cc: Simon Horman <horms@kernel.org>,
	Sai Krishna Gajula <saikrishnag@marvell.com>,
	Thomas Gleixner <tglx@linutronix.de>,
	Rob Herring <robh@kernel.org>,
	Krzysztof Kozlowski <krzk+dt@kernel.org>,
	Conor Dooley <conor+dt@kernel.org>,
	"David S. Miller" <davem@davemloft.net>,
	Eric Dumazet <edumazet@google.com>,
	Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>,
	Lee Jones <lee@kernel.org>, Arnd Bergmann <arnd@arndb.de>,
	Horatiu Vultur <horatiu.vultur@microchip.com>,
	UNGLinuxDriver@microchip.com, Andrew Lunn <andrew@lunn.ch>,
	Heiner Kallweit <hkallweit1@gmail.com>,
	Russell King <linux@armlinux.org.uk>,
	Saravana Kannan <saravanak@google.com>,
	Bjorn Helgaas <bhelgaas@google.com>,
	Philipp Zabel <p.zabel@pengutronix.de>,
	Lars Povlsen <lars.povlsen@microchip.com>,
	Steen Hegelund <Steen.Hegelund@microchip.com>,
	Daniel Machon <daniel.machon@microchip.com>,
	Alexandre Belloni <alexandre.belloni@bootlin.com>,
	linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
	netdev@vger.kernel.org, linux-pci@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org,
	Allan Nielsen <allan.nielsen@microchip.com>,
	Luca Ceresoli <luca.ceresoli@bootlin.com>,
	Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: Re: [PATCH v2 09/19] irqdomain: Add missing parameter descriptions in docs
Date: Thu, 6 Jun 2024 09:14:46 +0200	[thread overview]
Message-ID: <20240606091446.03f262fa@bootlin.com> (raw)
In-Reply-To: <ZmDEVoC9NUh7Gg7k@surfacebook.localdomain>

Hi Andy,

On Wed, 5 Jun 2024 23:02:30 +0300
Andy Shevchenko <andy.shevchenko@gmail.com> wrote:

> Mon, May 27, 2024 at 06:14:36PM +0200, Herve Codina kirjoitti:
> > During compilation, several warning of the following form were raised:
> >   Function parameter or struct member 'x' not described in 'yyy'
> > 
> > Add the missing function parameter descriptions.  
> 
> ...
> 
> >  /**
> >   * irq_domain_translate_onecell() - Generic translate for direct one cell
> >   * bindings
> > + * @d:		Interrupt domain involved in the translation
> > + * @fwspec:	The firmware interrupt specifier to translate
> > + * @out_hwirq:	Pointer to storage for the hardware interrupt number
> > + * @out_type:	Pointer to storage for the interrupt type  
> 
> (kernel-doc perhaps will complain on something missing here)
> 
> >   */
> >  int irq_domain_translate_onecell(struct irq_domain *d,  
> 
> You can go further and run
> 
> 	scripts/kernel-doc -v -none -Wall ...
> 
> against this file and fix more issues, like I believe in the above excerpt.
> 

Yes indeed, I missed the return values.
Will be updated in the next iteration.

Best regards,
Hervé