Commit 7a447968 authored by Randy Dunlap's avatar Randy Dunlap Committed by Tejun Heo
Browse files

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: a72232ea ("cgroup: Add misc cgroup controller")
Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Cc: cgroups@vger.kernel.org
Signed-off-by: default avatarTejun Heo <tj@kernel.org>
parent 1c0be3f7

include/linux/misc_cgroup.h

+4 −3
Original line number Diff line number Diff line
@@ -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

};