diff mbox series

kernel/power: convert comment from kernel-doc to plain comment

Message ID 20250111063107.910825-1-rdunlap@infradead.org
State New
Headers show
Series kernel/power: convert comment from kernel-doc to plain comment | expand

Commit Message

Randy Dunlap Jan. 11, 2025, 6:31 a.m. UTC
Modify a non-kernel-doc comment to begin with /* instead of /**
so that it does not cause a kernel-doc warning.

power.h:114: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 *      Auxiliary structure used for reading the snapshot image data and
power.h:114: warning: missing initial short description on line:
 *      Auxiliary structure used for reading the snapshot image data and

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: "Rafael J. Wysocki" <rafael@kernel.org>
Cc: Pavel Machek <pavel@ucw.cz>
Cc: Len Brown <len.brown@intel.com>
Cc: linux-pm@vger.kernel.org
---
 kernel/power/power.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff mbox series

Patch

--- linux-next-20250108.orig/kernel/power/power.h
+++ linux-next-20250108/kernel/power/power.h
@@ -110,7 +110,7 @@  extern int hibernate_preallocate_memory(
 
 extern void clear_or_poison_free_pages(void);
 
-/**
+/*
  *	Auxiliary structure used for reading the snapshot image data and
  *	metadata from and writing them to the list of page backup entries
  *	(PBEs) which is the main data structure of swsusp.