2021-07-02 05:19:44

by Lukas Bulwahn

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 <[email protected]>
---
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

2021-07-14 20:12:22

by Nick Desaulniers

Subject: Re: [PATCH] gcov: clang: rectify gcov_info_add's kernel-doc

On Thu, Jul 1, 2021 at 9:50 PM Lukas Bulwahn <[email protected]> wrote:
>
> 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 <[email protected]>

Thanks Lukas!
Reviewed-by: Nick Desaulniers <[email protected]>

> ---
> 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
>


--
Thanks,
~Nick Desaulniers