From mboxrd@z Thu Jan 1 00:00:00 1970 From: Daniel Thompson Date: Thu, 25 Jun 2020 09:40:51 +0000 Subject: Re: [PATCH 3/8] backlight: ili922x: Add missing kerneldoc descriptions for CHECK_FREQ_REG() args Message-Id: <20200625094051.u4hanl3rycczlwiy@holly.lan> List-Id: References: <20200624145721.2590327-1-lee.jones@linaro.org> <20200624145721.2590327-4-lee.jones@linaro.org> In-Reply-To: <20200624145721.2590327-4-lee.jones@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit To: Lee Jones Cc: linux-fbdev@vger.kernel.org, Bartlomiej Zolnierkiewicz , jingoohan1@gmail.com, linux-kernel@vger.kernel.org, stable@vger.kernel.org, dri-devel@lists.freedesktop.org, Software Engineering , linux-arm-kernel@lists.infradead.org On Wed, Jun 24, 2020 at 03:57:16PM +0100, Lee Jones wrote: > Kerneldoc syntax is used, but not complete. Descriptions required. > > Prevents warnings like: > > drivers/video/backlight/ili922x.c:116: warning: Function parameter or member 's' not described in 'CHECK_FREQ_REG' > drivers/video/backlight/ili922x.c:116: warning: Function parameter or member 'x' not described in 'CHECK_FREQ_REG' > > Cc: > Cc: Bartlomiej Zolnierkiewicz > Cc: Software Engineering > Signed-off-by: Lee Jones > --- > drivers/video/backlight/ili922x.c | 2 ++ > 1 file changed, 2 insertions(+) > > diff --git a/drivers/video/backlight/ili922x.c b/drivers/video/backlight/ili922x.c > index 9c5aa3fbb2842..8cb4b9d3c3bba 100644 > --- a/drivers/video/backlight/ili922x.c > +++ b/drivers/video/backlight/ili922x.c > @@ -107,6 +107,8 @@ > * lower frequency when the registers are read/written. > * The macro sets the frequency in the spi_transfer structure if > * the frequency exceeds the maximum value. > + * @s: pointer to controller side proxy for an SPI slave device What's wrong with "a pointer to an SPI device"? I am aware, having looked it up to find out what the above actually means, that this is how struct spi_device is described in its own kernel doc but quoting at that level of detail of both overkill and confusing. Daniel. > + * @x: pointer to the read/write buffer pair > */ > #define CHECK_FREQ_REG(s, x) \ > do { \ > -- > 2.25.1 >