[PATCH] kernel/power: convert comment from kernel-doc to plain comment
From: Randy Dunlap
Date: Sat Jan 11 2025 - 01:31:18 EST
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@xxxxxxxxxxxxx>
Cc: "Rafael J. Wysocki" <rafael@xxxxxxxxxx>
Cc: Pavel Machek <pavel@xxxxxx>
Cc: Len Brown <len.brown@xxxxxxxxx>
Cc: linux-pm@xxxxxxxxxxxxxxx
---
kernel/power/power.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
--- 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.