linux-kernel - Re: [PATCH v2] backlight: ili922x: fix kernel-doc warnings & notation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20211116115523.oobk2tfidvup5czz@maple.lan>
Date:   Tue, 16 Nov 2021 11:55:23 +0000
From:   Daniel Thompson <daniel.thompson@...aro.org>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org, kernel test robot <lkp@...el.com>,
        Lee Jones <lee.jones@...aro.org>,
        Jingoo Han <jingoohan1@...il.com>,
        dri-devel@...ts.freedesktop.org, Stefano Babic <sbabic@...x.de>,
        Anatolij Gustschin <agust@...x.de>
Subject: Re: [PATCH v2] backlight: ili922x: fix kernel-doc warnings & notation

On Mon, Nov 15, 2021 at 06:33:55PM -0800, Randy Dunlap wrote:
> Convert function-like macro comments to kernel-doc notation and
> fix other kernel-doc warnings:
> 
> drivers/video/backlight/ili922x.c:85: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>     * START_BYTE(id, rs, rw)
> drivers/video/backlight/ili922x.c:118: warning: expecting prototype for CHECK_FREQ_REG(spi_device s, spi_transfer x)(). Prototype was for CHECK_FREQ_REG() instead
> 
> ili922x.c:92: warning: contents before sections
> ili922x.c:150: warning: No description found for return value of 'ili922x_read_status'
> ili922x.c:193: warning: No description found for return value of 'ili922x_read'
> ili922x.c:247: warning: No description found for return value of 'ili922x_write'
> ili922x.c:353: warning: No description found for return value of 'ili922x_poweron'
> ili922x.c:382: warning: No description found for return value of 'ili922x_poweroff'
> 
> Fixes: 4cfbfa971478 ("video: backlight: add ili922x lcd driver")
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Reported-by: kernel test robot <lkp@...el.com>
> Cc: Lee Jones <lee.jones@...aro.org>
> Cc: Daniel Thompson <daniel.thompson@...aro.org>
> Cc: Jingoo Han <jingoohan1@...il.com>
> Cc: dri-devel@...ts.freedesktop.org
> Cc: Stefano Babic <sbabic@...x.de>
> Cc: Anatolij Gustschin <agust@...x.de>
> ---
> v2: add periods at end of sentences so that the generated documentation
>     flows correctly. (thanks, Daniel)

Reviewed-by: Daniel Thompson <daniel.thompson@...aro.org>


Daniel.