linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] gcov: clang: rectify gcov_info_add's kernel-doc
@ 2021-07-02  4:49 Lukas Bulwahn
  2021-07-14 19:47 ` Nick Desaulniers
  0 siblings, 1 reply; 2+ messages in thread
From: Lukas Bulwahn @ 2021-07-02  4:49 UTC (permalink / raw)
  To: Peter Oberparleiter, Nick Desaulniers, Nathan Chancellor,
	clang-built-linux
  Cc: kernel-janitors, linux-kernel, Lukas Bulwahn

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@gmail.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


^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] gcov: clang: rectify gcov_info_add's kernel-doc
  2021-07-02  4:49 [PATCH] gcov: clang: rectify gcov_info_add's kernel-doc Lukas Bulwahn
@ 2021-07-14 19:47 ` Nick Desaulniers
  0 siblings, 0 replies; 2+ messages in thread
From: Nick Desaulniers @ 2021-07-14 19:47 UTC (permalink / raw)
  To: Lukas Bulwahn
  Cc: Peter Oberparleiter, Nathan Chancellor, clang-built-linux,
	kernel-janitors, linux-kernel

On Thu, Jul 1, 2021 at 9:50 PM Lukas Bulwahn <lukas.bulwahn@gmail.com> 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 <lukas.bulwahn@gmail.com>

Thanks Lukas!
Reviewed-by: Nick Desaulniers <ndesaulniers@google.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
>


-- 
Thanks,
~Nick Desaulniers

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2021-07-14 20:04 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-07-02  4:49 [PATCH] gcov: clang: rectify gcov_info_add's kernel-doc Lukas Bulwahn
2021-07-14 19:47 ` Nick Desaulniers

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).