samples: bpf: Ix kernel-doc syntax in file header
authorAditya Srivastava <yashsri421@gmail.com>
Sun, 23 May 2021 15:14:08 +0000 (20:44 +0530)
committerAndrii Nakryiko <andrii@kernel.org>
Tue, 25 May 2021 04:06:02 +0000 (21:06 -0700)
commit4ce7d68beb9e63d0a0a427cc2b89ec0c68f24b3d
treeedcef7612c525181b03eb0da083c8b7d1506168e
parent9f0c317f6aa12b160103ee3946d79276c14b95e2
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
samples/bpf/ibumad_kern.c
samples/bpf/ibumad_user.c