Skip to content

Commit

Permalink
PM: hibernate: swap: don't use /** for non-kernel-doc comments
Browse files Browse the repository at this point in the history
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>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
  • Loading branch information
Randy Dunlap authored and Rafael J. Wysocki committed Jan 20, 2023
1 parent 5dc4c99 commit 6b37dfc
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions kernel/power/swap.c
Original file line number Diff line number Diff line change
Expand Up @@ -581,7 +581,7 @@ static int save_image(struct swap_map_handle *handle,
return ret;
}

/**
/*
* Structure used for CRC32.
*/
struct crc_data {
Expand All @@ -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)
Expand All @@ -623,7 +623,7 @@ static int crc32_threadfn(void *data)
}
return 0;
}
/**
/*
* Structure used for LZO data compression.
*/
struct cmp_data {
Expand All @@ -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)
Expand Down Expand Up @@ -948,9 +948,9 @@ int swsusp_write(unsigned int flags)
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)
Expand Down Expand Up @@ -1107,7 +1107,7 @@ static int load_image(struct swap_map_handle *handle,
return ret;
}

/**
/*
* Structure used for LZO data decompression.
*/
struct dec_data {
Expand All @@ -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)
Expand Down

0 comments on commit 6b37dfc

Please sign in to comment.