diff options
| author | Randy Dunlap <rdunlap@infradead.org> | 2024-07-01 16:49:37 -0700 |
|---|---|---|
| committer | Tejun Heo <tj@kernel.org> | 2024-07-02 07:12:20 -1000 |
| commit | 7a4479680d7fd05c7a3efa87b41f421af48fbbdf (patch) | |
| tree | ea2c1d4897c238b67b9d24d56b64a0e535dbd27c | |
| parent | 1c0be3f7b2f0dcca5dd237233f02a44e7af8c23a (diff) | |
cgroup_misc: add kernel-doc comments for enum misc_res_type
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
Signed-off-by: Tejun Heo <tj@kernel.org>
| -rw-r--r-- | include/linux/misc_cgroup.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/include/linux/misc_cgroup.h b/include/linux/misc_cgroup.h index e799b1f8d05b..d70eab2501ee 100644 --- 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 }; |