* [PATCH] samples: bpf: ix kernel-doc syntax in file header
@ 2021-05-23 15:09 Aditya Srivastava
2021-05-23 15:14 ` [PATCH v2] " Aditya Srivastava
0 siblings, 1 reply; 4+ messages in thread
From: Aditya Srivastava @ 2021-05-23 15:09 UTC (permalink / raw)
To: kafai
Cc: jgg, songliubraving, daniel, linux-doc, linux-rdma, netdev,
rdunlap, john.fastabend, linux-kernel, ast, yashsri421, dledford,
yhs, andrii, bpf, kpsingh, linux-kernel-mentees
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header for samples/bpf/ibumad_kern.c follows this syntax, but
the content inside does not comply with kernel-doc.
This line was probably not meant for kernel-doc parsing, but is parsed
due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
causes unexpected warnings from kernel-doc:
warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* ibumad BPF sample kernel side
Provide a simple fix by replacing this occurrence with general comment
format, i.e. '/*', to prevent kernel-doc from parsing it.
Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
---
samples/bpf/ibumad_kern.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/samples/bpf/ibumad_kern.c b/samples/bpf/ibumad_kern.c
index 26dcd4dde946..9b193231024a 100644
--- a/samples/bpf/ibumad_kern.c
+++ b/samples/bpf/ibumad_kern.c
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB
-/**
+/*
* ibumad BPF sample kernel side
*
* This program is free software; you can redistribute it and/or
--
2.17.1
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
^ permalink raw reply related [flat|nested] 4+ messages in thread
* [PATCH v2] samples: bpf: ix kernel-doc syntax in file header
2021-05-23 15:09 [PATCH] samples: bpf: ix kernel-doc syntax in file header Aditya Srivastava
@ 2021-05-23 15:14 ` Aditya Srivastava
2021-05-23 16:07 ` Randy Dunlap
2021-05-25 4:10 ` patchwork-bot+netdevbpf
0 siblings, 2 replies; 4+ messages in thread
From: Aditya Srivastava @ 2021-05-23 15:14 UTC (permalink / raw)
To: kafai
Cc: jgg, songliubraving, daniel, linux-doc, linux-rdma, netdev,
rdunlap, john.fastabend, linux-kernel, ast, yashsri421, dledford,
yhs, andrii, bpf, kpsingh, linux-kernel-mentees
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header for samples/bpf/ibumad_kern.c follows this syntax, but
the content inside does not comply with kernel-doc.
This line was probably not meant for kernel-doc parsing, but is parsed
due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
causes unexpected warnings from kernel-doc:
warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* ibumad BPF sample kernel side
Provide a simple fix by replacing this occurrence with general comment
format, i.e. '/*', to prevent kernel-doc from parsing it.
Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
---
Changes in v2: Include changes for both, samples/bpf/ibumad_kern.c and samples/bpf/ibumad_user.c in the same patch
samples/bpf/ibumad_kern.c | 2 +-
samples/bpf/ibumad_user.c | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/samples/bpf/ibumad_kern.c b/samples/bpf/ibumad_kern.c
index 26dcd4dde946..9b193231024a 100644
--- a/samples/bpf/ibumad_kern.c
+++ b/samples/bpf/ibumad_kern.c
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB
-/**
+/*
* ibumad BPF sample kernel side
*
* This program is free software; you can redistribute it and/or
diff --git a/samples/bpf/ibumad_user.c b/samples/bpf/ibumad_user.c
index d83d8102f489..0746ca516097 100644
--- a/samples/bpf/ibumad_user.c
+++ b/samples/bpf/ibumad_user.c
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB
-/**
+/*
* ibumad BPF sample user side
*
* This program is free software; you can redistribute it and/or
--
2.17.1
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH v2] samples: bpf: ix kernel-doc syntax in file header
2021-05-23 15:14 ` [PATCH v2] " Aditya Srivastava
@ 2021-05-23 16:07 ` Randy Dunlap
2021-05-25 4:10 ` patchwork-bot+netdevbpf
1 sibling, 0 replies; 4+ messages in thread
From: Randy Dunlap @ 2021-05-23 16:07 UTC (permalink / raw)
To: Aditya Srivastava, kafai
Cc: songliubraving, daniel, linux-doc, linux-rdma, netdev,
john.fastabend, linux-kernel, ast, jgg, dledford, yhs, andrii,
bpf, kpsingh, linux-kernel-mentees
On 5/23/21 8:14 AM, Aditya Srivastava wrote:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for samples/bpf/ibumad_kern.c follows this syntax, but
> the content inside does not comply with kernel-doc.
>
> This line was probably not meant for kernel-doc parsing, but is parsed
> due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
> causes unexpected warnings from kernel-doc:
> warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> * ibumad BPF sample kernel side
>
> Provide a simple fix by replacing this occurrence with general comment
> format, i.e. '/*', to prevent kernel-doc from parsing it.
>
> Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.
> ---
> Changes in v2: Include changes for both, samples/bpf/ibumad_kern.c and samples/bpf/ibumad_user.c in the same patch
>
> samples/bpf/ibumad_kern.c | 2 +-
> samples/bpf/ibumad_user.c | 2 +-
> 2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/samples/bpf/ibumad_kern.c b/samples/bpf/ibumad_kern.c
> index 26dcd4dde946..9b193231024a 100644
> --- a/samples/bpf/ibumad_kern.c
> +++ b/samples/bpf/ibumad_kern.c
> @@ -1,6 +1,6 @@
> // SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB
>
> -/**
> +/*
> * ibumad BPF sample kernel side
> *
> * This program is free software; you can redistribute it and/or
> diff --git a/samples/bpf/ibumad_user.c b/samples/bpf/ibumad_user.c
> index d83d8102f489..0746ca516097 100644
> --- a/samples/bpf/ibumad_user.c
> +++ b/samples/bpf/ibumad_user.c
> @@ -1,6 +1,6 @@
> // SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB
>
> -/**
> +/*
> * ibumad BPF sample user side
> *
> * This program is free software; you can redistribute it and/or
>
--
~Randy
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH v2] samples: bpf: ix kernel-doc syntax in file header
2021-05-23 15:14 ` [PATCH v2] " Aditya Srivastava
2021-05-23 16:07 ` Randy Dunlap
@ 2021-05-25 4:10 ` patchwork-bot+netdevbpf
1 sibling, 0 replies; 4+ messages in thread
From: patchwork-bot+netdevbpf @ 2021-05-25 4:10 UTC (permalink / raw)
To: Aditya Srivastava
Cc: songliubraving, daniel, linux-doc, linux-rdma, netdev, rdunlap,
john.fastabend, linux-kernel, ast, jgg, dledford, yhs, andrii,
bpf, kpsingh, linux-kernel-mentees, kafai
Hello:
This patch was applied to bpf/bpf-next.git (refs/heads/master):
On Sun, 23 May 2021 20:44:08 +0530 you wrote:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for samples/bpf/ibumad_kern.c follows this syntax, but
> the content inside does not comply with kernel-doc.
>
> This line was probably not meant for kernel-doc parsing, but is parsed
> due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
> causes unexpected warnings from kernel-doc:
> warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> * ibumad BPF sample kernel side
>
> [...]
Here is the summary with links:
- [v2] samples: bpf: ix kernel-doc syntax in file header
https://git.kernel.org/bpf/bpf-next/c/4ce7d68beb9e
You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2021-05-25 4:10 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-05-23 15:09 [PATCH] samples: bpf: ix kernel-doc syntax in file header Aditya Srivastava
2021-05-23 15:14 ` [PATCH v2] " Aditya Srivastava
2021-05-23 16:07 ` Randy Dunlap
2021-05-25 4:10 ` patchwork-bot+netdevbpf
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox