gcov: clang: rectify gcov_info_add's kernel-doc
Subsystems (2)
PATCH 1/1 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.
--- kernel/gcov/clang.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
kernel/gcov/clang.c +3 -3
@@ -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) {
Signature · 1 line
2.17.1
Quoted 8 lines · Lukas Bulwahn
For
gcov_info_add,./scripts/kernel-doc-nonekernel/gcov/clang.cwarns: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'
Quoted 5 lines
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 <[email protected]>
Thanks Lukas!
Quoted 25 lines
--- kernel/gcov/clang.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)kernel/gcov/clang.c +3
-4@@ -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
Signature · 2 lines
Thanks, ~Nick Desaulniers