diff options
| author | Aditya Srivastava <yashsri421@gmail.com> | 2021-05-23 18:14:08 +0300 |
|---|---|---|
| committer | Andrii Nakryiko <andrii@kernel.org> | 2021-05-25 07:06:02 +0300 |
| commit | 4ce7d68beb9e63d0a0a427cc2b89ec0c68f24b3d (patch) | |
| tree | edcef7612c525181b03eb0da083c8b7d1506168e | |
| parent | 9f0c317f6aa12b160103ee3946d79276c14b95e2 (diff) | |
| download | linux-4ce7d68beb9e63d0a0a427cc2b89ec0c68f24b3d.tar.xz | |
samples: bpf: Ix kernel-doc syntax in file header
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>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/bpf/20210523151408.22280-1-yashsri421@gmail.com
| -rw-r--r-- | samples/bpf/ibumad_kern.c | 2 | ||||
| -rw-r--r-- | 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 |