| From: Randy Dunlap <rdunlap@infradead.org> |
| Subject: userns: fix a struct's kernel-doc notation |
| Date: Sat, 7 Jan 2023 18:12:43 -0800 |
| |
| Use the 'struct' keyword for a struct's kernel-doc notation to avoid a |
| kernel-doc warning: |
| |
| kernel/user_namespace.c:232: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst |
| * idmap_key struct holds the information necessary to find an idmapping in a |
| |
| Link: https://lkml.kernel.org/r/20230108021243.16683-1-rdunlap@infradead.org |
| Signed-off-by: Randy Dunlap <rdunlap@infradead.org> |
| Cc: Eric Biederman <ebiederm@xmission.com> |
| Signed-off-by: Andrew Morton <akpm@linux-foundation.org> |
| --- |
| |
| |
| --- a/kernel/user_namespace.c~userns-fix-a-structs-kernel-doc-notation |
| +++ a/kernel/user_namespace.c |
| @@ -229,7 +229,7 @@ void __put_user_ns(struct user_namespace |
| EXPORT_SYMBOL(__put_user_ns); |
| |
| /** |
| - * idmap_key struct holds the information necessary to find an idmapping in a |
| + * struct idmap_key - holds the information necessary to find an idmapping in a |
| * sorted idmap array. It is passed to cmp_map_id() as first argument. |
| */ |
| struct idmap_key { |
| _ |
