| Message ID | 20250111063107.910825-1-rdunlap@infradead.org (mailing list archive) |
|---|---|
| State | Queued |
| Delegated to: | Rafael Wysocki |
| Headers | show |
| Series | kernel/power: convert comment from kernel-doc to plain comment | expand |
On Fri 2025-01-10 22:31:07, Randy Dunlap wrote: > 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> Acked-by: Pavel Machek <pavel@ucw.cz>
On Sat, Jan 11, 2025 at 2:15 PM Pavel Machek <pavel@ucw.cz> wrote: > > On Fri 2025-01-10 22:31:07, Randy Dunlap wrote: > > 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> > > Acked-by: Pavel Machek <pavel@ucw.cz> Applied as 6.14 material, thanks!
--- 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.
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(-)