linux-kernel - [PATCH] gcov: clang: rectify gcov_info

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-next>] [day] [month] [year] [list]

Message-Id: <20210702044950.10411-1-lukas.bulwahn@gmail.com>
Date:   Fri,  2 Jul 2021 06:49:50 +0200
From:   Lukas Bulwahn <lukas.bulwahn@...il.com>
To:     Peter Oberparleiter <oberpar@...ux.ibm.com>,
        Nick Desaulniers <ndesaulniers@...gle.com>,
        Nathan Chancellor <natechancellor@...il.com>,
        clang-built-linux@...glegroups.com
Cc:     kernel-janitors@...r.kernel.org, linux-kernel@...r.kernel.org,
        Lukas Bulwahn <lukas.bulwahn@...il.com>
Subject: [PATCH] gcov: clang: rectify gcov_info_add's kernel-doc

For gcov_info_add, ./scripts/kernel-doc -none kernel/gcov/clang.c warns:

  warning: Function parameter or member 'dst' not described in 'gcov_info_add'
  warning: Function parameter or member 'src' not described in 'gcov_info_add'
  warning: Excess function parameter 'dest' description in 'gcov_info_add'
  warning: Excess function parameter 'source' description in 'gcov_info_add'

Obviously, the kernel-doc's and function's parameter names slightly mismatch.

Adjust the kernel-doc description to make kernel-doc happy.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@...il.com>
---
 kernel/gcov/clang.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/kernel/gcov/clang.c b/kernel/gcov/clang.c
index cbb0bed958ab..214696e28ec1 100644
--- a/kernel/gcov/clang.c
+++ b/kernel/gcov/clang.c
@@ -264,10 +264,10 @@ int gcov_info_is_compatible(struct gcov_info *info1, struct gcov_info *info2)
 
 /**
  * gcov_info_add - add up profiling data
- * @dest: profiling data set to which data is added
- * @source: profiling data set which is added
+ * @dst: profiling data set to which data is added
+ * @src: profiling data set which is added
  *
- * Adds profiling counts of @source to @dest.
+ * Adds profiling counts of @src to @dst.
  */
 void gcov_info_add(struct gcov_info *dst, struct gcov_info *src)
 {
-- 
2.17.1