Commit 025d5ac9 authored Oct 06, 2023 by Randy Dunlap Committed by Ingo Molnar Oct 08, 2023

x86/resctrl: Fix kernel-doc warnings

The kernel test robot reported kernel-doc warnings here:

monitor.c:34: warning: Cannot understand * @rmid_free_lru A least recently used list of free RMIDs on line 34 - I thought it was a doc line
monitor.c:41: warning: Cannot understand * @rmid_limbo_count count of currently unused but (potentially) on line 41 - I thought it was a doc line
monitor.c:50: warning: Cannot understand * @rmid_entry - The entry in the limbo and free lists. on line 50 - I thought it was a doc line

We don't have a syntax for documenting individual data items via
kernel-doc, so remove the "/**" kernel-doc markers and add a hyphen
for consistency.

Fixes: 6a445edc ("x86/intel_rdt/cqm: Add RDT monitoring initialization")
Fixes: 24247aee ("x86/intel_rdt/cqm: Improve limbo list processing")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Link: https://lore.kernel.org/r/20231006235132.16227-1-rdunlap@infradead.org

parent 62d5e970

arch/x86/kernel/cpu/resctrl/monitor.c

+5 −5

Original line number	Diff line number	Diff line
		@@ -30,15 +30,15 @@ struct rmid_entry {
		struct list_head list;
		};

		/**
		* @rmid_free_lru A least recently used list of free RMIDs
		/*
		* @rmid_free_lru - A least recently used list of free RMIDs
		* These RMIDs are guaranteed to have an occupancy less than the
		* threshold occupancy
		*/
		static LIST_HEAD(rmid_free_lru);

		/**
		* @rmid_limbo_count count of currently unused but (potentially)
		/*
		* @rmid_limbo_count - count of currently unused but (potentially)
		* dirty RMIDs.
		* This counts RMIDs that no one is currently using but that
		* may have a occupancy value > resctrl_rmid_realloc_threshold. User can
		@@ -46,7 +46,7 @@ static LIST_HEAD(rmid_free_lru);
		*/
		static unsigned int rmid_limbo_count;

		/**
		/*
		* @rmid_entry - The entry in the limbo and free lists.
		*/
		static struct rmid_entry *rmid_ptrs;