PM: hibernate: swap: don't use /** for non-kernel-doc comments
Commit Message
kernel-doc complains about multiple occurrences of "/**" being used
for something that is not a kernel-doc comment, so change all of these
to just use "/*" comment style.
The warning message for all of these is:
FILE:LINE: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
kernel/power/swap.c:585: warning: ...
Structure used for CRC32.
kernel/power/swap.c:600: warning: ...
* CRC32 update function that runs in its own thread.
kernel/power/swap.c:627: warning: ...
* Structure used for LZO data compression.
kernel/power/swap.c:644: warning: ...
* Compression function that runs in its own thread.
kernel/power/swap.c:952: warning: ...
* The following functions allow us to read data using a swap map
kernel/power/swap.c:1111: warning: ...
* Structure used for LZO data decompression.
kernel/power/swap.c:1127: warning: ...
* Decompression function that runs in its own thread.
Also correct one spello/typo.
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/swap.c | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
Comments
On Tue, Jan 3, 2023 at 4:28 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> kernel-doc complains about multiple occurrences of "/**" being used
> for something that is not a kernel-doc comment, so change all of these
> to just use "/*" comment style.
>
> The warning message for all of these is:
>
> FILE:LINE: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>
> kernel/power/swap.c:585: warning: ...
> Structure used for CRC32.
> kernel/power/swap.c:600: warning: ...
> * CRC32 update function that runs in its own thread.
> kernel/power/swap.c:627: warning: ...
> * Structure used for LZO data compression.
> kernel/power/swap.c:644: warning: ...
> * Compression function that runs in its own thread.
> kernel/power/swap.c:952: warning: ...
> * The following functions allow us to read data using a swap map
> kernel/power/swap.c:1111: warning: ...
> * Structure used for LZO data decompression.
> kernel/power/swap.c:1127: warning: ...
> * Decompression function that runs in its own thread.
>
> Also correct one spello/typo.
>
> 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/swap.c | 16 ++++++++--------
> 1 file changed, 8 insertions(+), 8 deletions(-)
>
> diff -- a/kernel/power/swap.c b/kernel/power/swap.c
> --- a/kernel/power/swap.c
> +++ b/kernel/power/swap.c
> @@ -581,7 +581,7 @@ static int save_image(struct swap_map_ha
> return ret;
> }
>
> -/**
> +/*
> * Structure used for CRC32.
> */
> struct crc_data {
> @@ -596,7 +596,7 @@ struct crc_data {
> unsigned char *unc[LZO_THREADS]; /* uncompressed data */
> };
>
> -/**
> +/*
> * CRC32 update function that runs in its own thread.
> */
> static int crc32_threadfn(void *data)
> @@ -623,7 +623,7 @@ static int crc32_threadfn(void *data)
> }
> return 0;
> }
> -/**
> +/*
> * Structure used for LZO data compression.
> */
> struct cmp_data {
> @@ -640,7 +640,7 @@ struct cmp_data {
> unsigned char wrk[LZO1X_1_MEM_COMPRESS]; /* compression workspace */
> };
>
> -/**
> +/*
> * Compression function that runs in its own thread.
> */
> static int lzo_compress_threadfn(void *data)
> @@ -948,9 +948,9 @@ out_finish:
> return error;
> }
>
> -/**
> +/*
> * The following functions allow us to read data using a swap map
> - * in a file-alike way
> + * in a file-like way.
> */
>
> static void release_swap_reader(struct swap_map_handle *handle)
> @@ -1107,7 +1107,7 @@ static int load_image(struct swap_map_ha
> return ret;
> }
>
> -/**
> +/*
> * Structure used for LZO data decompression.
> */
> struct dec_data {
> @@ -1123,7 +1123,7 @@ struct dec_data {
> unsigned char cmp[LZO_CMP_SIZE]; /* compressed buffer */
> };
>
> -/**
> +/*
> * Decompression function that runs in its own thread.
> */
> static int lzo_decompress_threadfn(void *data)
Applied as 6.3 material, thanks!
@@ -581,7 +581,7 @@ static int save_image(struct swap_map_ha
return ret;
}
-/**
+/*
* Structure used for CRC32.
*/
struct crc_data {
@@ -596,7 +596,7 @@ struct crc_data {
unsigned char *unc[LZO_THREADS]; /* uncompressed data */
};
-/**
+/*
* CRC32 update function that runs in its own thread.
*/
static int crc32_threadfn(void *data)
@@ -623,7 +623,7 @@ static int crc32_threadfn(void *data)
}
return 0;
}
-/**
+/*
* Structure used for LZO data compression.
*/
struct cmp_data {
@@ -640,7 +640,7 @@ struct cmp_data {
unsigned char wrk[LZO1X_1_MEM_COMPRESS]; /* compression workspace */
};
-/**
+/*
* Compression function that runs in its own thread.
*/
static int lzo_compress_threadfn(void *data)
@@ -948,9 +948,9 @@ out_finish:
return error;
}
-/**
+/*
* The following functions allow us to read data using a swap map
- * in a file-alike way
+ * in a file-like way.
*/
static void release_swap_reader(struct swap_map_handle *handle)
@@ -1107,7 +1107,7 @@ static int load_image(struct swap_map_ha
return ret;
}
-/**
+/*
* Structure used for LZO data decompression.
*/
struct dec_data {
@@ -1123,7 +1123,7 @@ struct dec_data {
unsigned char cmp[LZO_CMP_SIZE]; /* compressed buffer */
};
-/**
+/*
* Decompression function that runs in its own thread.
*/
static int lzo_decompress_threadfn(void *data)