linux-kernel - Re: [PATCH net-next] net: ipa: fix kerneldoc comments

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]

Date:   Mon, 13 Jul 2020 17:12:05 -0700 (PDT)
From:   David Miller <davem@...emloft.net>
To:     elder@...aro.org
Cc:     kuba@...nel.org, evgreen@...omium.org, subashab@...eaurora.org,
        cpratapa@...eaurora.org, bjorn.andersson@...aro.org,
        netdev@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH net-next] net: ipa: fix kerneldoc comments

From: Alex Elder <elder@...aro.org>
Date: Mon, 13 Jul 2020 07:24:18 -0500

> This commit affects comments (and in one case, whitespace) only.
> 
> Throughout the IPA code, return statements are documented using
> "@Return:", whereas they should use "Return:" instead.  Fix these
> mistakes.
> 
> In function definitions, some parameters are missing their comment
> to describe them.  And in structure definitions, some fields are
> missing their comment to describe them.  Add these missing
> descriptions.
> 
> Some arguments changed name and type along the way, but their
> descriptions were not updated (an endpoint pointer is now used in
> many places that previously used an endpoint ID).  Fix these
> incorrect parameter descriptions.
> 
> In the description for the ipa_clock structure, one field had a
> semicolon instead of a colon in its description.  Fix this.
> 
> Add a missing function description for ipa_gsi_endpoint_data_empty().
> 
> All of these issues were identified when building with "W=1".
> 
> Signed-off-by: Alex Elder <elder@...aro.org>

Applied, thanks Alex.