[PATCH] gcov: fix kernel-doc markup issue

[PATCH] gcov: fix kernel-doc markup issue

[Alex Shi]

Fix the following kernel-doc issue in gcov:
kernel/gcov/gcc_4_7.c:238: warning: Function parameter or member 'dst'
not described in 'gcov_info_add'
kernel/gcov/gcc_4_7.c:238: warning: Function parameter or member 'src'
not described in 'gcov_info_add'
kernel/gcov/gcc_4_7.c:238: warning: Excess function parameter 'dest'
description in 'gcov_info_add'
kernel/gcov/gcc_4_7.c:238: warning: Excess function parameter 'source'
description in 'gcov_info_add'

Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Cc: Peter Oberparleiter <oberpar@linux.ibm.com>
Cc: linux-kernel@vger.kernel.org
---
 kernel/gcov/gcc_4_7.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/kernel/gcov/gcc_4_7.c b/kernel/gcov/gcc_4_7.c
index 53c67c87f141..789c2a8ba801 100644
--- a/kernel/gcov/gcc_4_7.c
+++ b/kernel/gcov/gcc_4_7.c
@@ -229,10 +229,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.29.GIT

Re: [PATCH] gcov: fix kernel-doc markup issue

[Peter Oberparleiter]

On 13.11.2020 08:25, Alex Shi wrote:
> Fix the following kernel-doc issue in gcov:
> kernel/gcov/gcc_4_7.c:238: warning: Function parameter or member 'dst'
> not described in 'gcov_info_add'
> kernel/gcov/gcc_4_7.c:238: warning: Function parameter or member 'src'
> not described in 'gcov_info_add'
> kernel/gcov/gcc_4_7.c:238: warning: Excess function parameter 'dest'
> description in 'gcov_info_add'
> kernel/gcov/gcc_4_7.c:238: warning: Excess function parameter 'source'
> description in 'gcov_info_add'
> 
> Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
> Cc: Peter Oberparleiter <oberpar@linux.ibm.com>
> Cc: linux-kernel@vger.kernel.org

Looks good - thanks for the fix!

Acked-by: Peter Oberparleiter <oberpar@linux.ibm.com>

Andrew, could you add this patch via your tree?


Regards,
  Peter

-- 
Peter Oberparleiter
Linux on Z Development - IBM Germany