[PATCH] cgroup_misc: add kernel-doc comments for enum misc_res_type

[PATCH] cgroup_misc: add kernel-doc comments for enum misc_res_type

[Randy Dunlap]

Fully document enum misc_res_type with kernel-doc comments to prevent
kernel-doc warnings:

misc_cgroup.h:12: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Types of misc cgroup entries supported by the host.
misc_cgroup.h:12: warning: missing initial short description on line:
 * Types of misc cgroup entries supported by the host.

Fixes: a72232eabdfc ("cgroup: Add misc cgroup controller")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: cgroups@vger.kernel.org
---
Cc: Vipin Sharma <vipinsh@google.com>
Cc: Tejun Heo <tj@kernel.org>
Cc: Zefan Li <lizefan.x@bytedance.com>
Cc: Johannes Weiner <hannes@cmpxchg.org>

 include/linux/misc_cgroup.h |    7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff -- a/include/linux/misc_cgroup.h b/include/linux/misc_cgroup.h
--- a/include/linux/misc_cgroup.h
+++ b/include/linux/misc_cgroup.h
@@ -9,15 +9,16 @@
 #define _MISC_CGROUP_H_
 
 /**
- * Types of misc cgroup entries supported by the host.
+ * enum misc_res_type - Types of misc cgroup entries supported by the host.
  */
 enum misc_res_type {
 #ifdef CONFIG_KVM_AMD_SEV
-	/* AMD SEV ASIDs resource */
+	/** @MISC_CG_RES_SEV: AMD SEV ASIDs resource */
 	MISC_CG_RES_SEV,
-	/* AMD SEV-ES ASIDs resource */
+	/** @MISC_CG_RES_SEV_ES: AMD SEV-ES ASIDs resource */
 	MISC_CG_RES_SEV_ES,
 #endif
+	/** @MISC_CG_RES_TYPES: count of enum misc_res_type constants */
 	MISC_CG_RES_TYPES
 };
 

Re: [PATCH] cgroup_misc: add kernel-doc comments for enum misc_res_type

[Tejun Heo]

On Mon, Jul 01, 2024 at 04:49:37PM -0700, Randy Dunlap wrote:
> Fully document enum misc_res_type with kernel-doc comments to prevent
> kernel-doc warnings:
> 
> misc_cgroup.h:12: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Types of misc cgroup entries supported by the host.
> misc_cgroup.h:12: warning: missing initial short description on line:
>  * Types of misc cgroup entries supported by the host.
> 
> Fixes: a72232eabdfc ("cgroup: Add misc cgroup controller")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: cgroups@vger.kernel.org

Applied to cgroup/for-6.11.

Thanks.

-- 
tejun