Skip to content

Commit 6b37dfc

Browse files
rddunlaprafaeljw
authored andcommitted
PM: hibernate: swap: don't use /** for non-kernel-doc comments
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 <[email protected]> Signed-off-by: Rafael J. Wysocki <[email protected]>
1 parent 5dc4c99 commit 6b37dfc

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

kernel/power/swap.c

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -581,7 +581,7 @@ static int save_image(struct swap_map_handle *handle,
581581
return ret;
582582
}
583583

584-
/**
584+
/*
585585
* Structure used for CRC32.
586586
*/
587587
struct crc_data {
@@ -596,7 +596,7 @@ struct crc_data {
596596
unsigned char *unc[LZO_THREADS]; /* uncompressed data */
597597
};
598598

599-
/**
599+
/*
600600
* CRC32 update function that runs in its own thread.
601601
*/
602602
static int crc32_threadfn(void *data)
@@ -623,7 +623,7 @@ static int crc32_threadfn(void *data)
623623
}
624624
return 0;
625625
}
626-
/**
626+
/*
627627
* Structure used for LZO data compression.
628628
*/
629629
struct cmp_data {
@@ -640,7 +640,7 @@ struct cmp_data {
640640
unsigned char wrk[LZO1X_1_MEM_COMPRESS]; /* compression workspace */
641641
};
642642

643-
/**
643+
/*
644644
* Compression function that runs in its own thread.
645645
*/
646646
static int lzo_compress_threadfn(void *data)
@@ -948,9 +948,9 @@ int swsusp_write(unsigned int flags)
948948
return error;
949949
}
950950

951-
/**
951+
/*
952952
* The following functions allow us to read data using a swap map
953-
* in a file-alike way
953+
* in a file-like way.
954954
*/
955955

956956
static void release_swap_reader(struct swap_map_handle *handle)
@@ -1107,7 +1107,7 @@ static int load_image(struct swap_map_handle *handle,
11071107
return ret;
11081108
}
11091109

1110-
/**
1110+
/*
11111111
* Structure used for LZO data decompression.
11121112
*/
11131113
struct dec_data {
@@ -1123,7 +1123,7 @@ struct dec_data {
11231123
unsigned char cmp[LZO_CMP_SIZE]; /* compressed buffer */
11241124
};
11251125

1126-
/**
1126+
/*
11271127
* Decompression function that runs in its own thread.
11281128
*/
11291129
static int lzo_decompress_threadfn(void *data)

0 commit comments

Comments
 (0)