linux-kernel - Re: [PATCH v2 14/28] ASoC: samsung: pcm: Demote half-documented kerneldoc header

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 for Android: free password hash cracker in your pocket

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

Message-ID: <f85a033f-b435-2611-5be5-1c83edf8cd42@kernel.org>
Date:   Wed, 8 Jul 2020 10:39:30 +0200
From:   Sylwester Nawrocki <snawrocki@...nel.org>
To:     Lee Jones <lee.jones@...aro.org>, broonie@...nel.org,
        lgirdwood@...il.com, perex@...ex.cz, tiwai@...e.com
Cc:     linux-arm-kernel@...ts.infradead.org, linux-kernel@...r.kernel.org,
        alsa-devel@...a-project.org, Krzysztof Kozlowski <krzk@...nel.org>,
        Sangbeom Kim <sbkim73@...sung.com>,
        Sylwester Nawrocki <s.nawrocki@...sung.com>,
        Jaswinder Singh <jassisinghbrar@...il.com>
Subject: Re: [PATCH v2 14/28] ASoC: samsung: pcm: Demote half-documented
 kerneldoc header

On 7/7/20 16:37, Lee Jones wrote:
> Ideally the author or someone 'in the know' should come back and
> provide the remainder of the documentation.  Until the kerneldoc
> checkers have been satisfied, let's just demote the header to a
> standard comment block.

Thanks for the patch Lee, Pierre-Luis Bossart has already corrected the 
documentation by adding missing entries in patch:

[PATCH v3 03/13] ASoC: samsung: pcm: fix kernel-doc

> Fixes the following W=1 kernel build warning(s):
> 
>   sound/soc/samsung/pcm.c:127: warning: Function parameter or member 'lock' not described in 's3c_pcm_info'
>   sound/soc/samsung/pcm.c:127: warning: Function parameter or member 'sclk_per_fs' not described in 's3c_pcm_info'
>   sound/soc/samsung/pcm.c:127: warning: Function parameter or member 'idleclk' not described in 's3c_pcm_info'
>   sound/soc/samsung/pcm.c:127: warning: Function parameter or member 'pclk' not described in 's3c_pcm_info'
>   sound/soc/samsung/pcm.c:127: warning: Function parameter or member 'cclk' not described in 's3c_pcm_info'

--
Regards,
Sylwester