mm/treewide: Add missing kernel-doc function comments.
Subsystems (2)
PATCH 1/1 mm/treewide: Add missing kernel-doc function comments.
Add kernel-doc style comments for the pfn_is_nosave and arch_hibernation_header_save functions.
Reported-by Abaci Robot <[email protected]>
Signed-off-by Yang Li <[email protected]>
--- arch/x86/power/hibernate.c | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-)
arch/x86/power/hibernate.c +7 -4
@@ -41,7 +41,8 @@ unsigned long temp_pgt __visible;unsigned long relocated_restore_code __visible;/** -* pfn_is_nosave - check if given pfn is in the 'nosave' section +* pfn_is_nosave - check if given pfn is in the 'nosave' section +* @pfn: The Page Frame Number to check */ int pfn_is_nosave (unsigned long pfn) {
@@ -84,9 +85,11 @@ static inline u32 compute_e820_crc32(struct e820_table *table)#endif /** -* arch_hibernation_header_save - populate the architecture specific part -* of a hibernation image header -* @addr: address to save the data at +* arch_hibernation_header_save - populate the architecture specific part +* of a hibernation image header +* @addr: address to save the data at +* @max_size: the maximum size of the data to save +* */ int arch_hibernation_header_save (void *addr,unsigned int max_size) {
Signature · 1 line
2.20.1.7.g153144c
Rafael J. Wysocki
maintainerQuoted 16 lines · Yang Li
Add kernel-doc style comments for the
pfn_is_nosaveandarch_hibernation_header_savefunctions.Reported-by Abaci Robot <[email protected]>Signed-off-by Yang Li <[email protected]>--- arch/x86/power/hibernate.c | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-)arch/x86/power/hibernate.c +0
-0
arch/x86/power/hibernate.c unsigned long temp_pgt __visible; · line 45
Quoted 6 lines
arch/x86/power/hibernate.c +2
-1@@ -41,7 +41,8 @@ unsigned long temp_pgt __visible;unsigned long relocated_restore_code __visible;/** -* pfn_is_nosave - check if given pfn is in the 'nosave' section +* pfn_is_nosave - check if given pfn is in the 'nosave' section +* @pfn: The Page Frame Number to check
This is fine.
arch/x86/power/hibernate.c static inline u32 compute_e820_crc32(struct e820_table *table) · line 89
Quoted 12 lines
arch/x86/power/hibernate.c +2
-3*/ int pfn_is_nosave (unsigned long pfn) {@@ -84,9 +85,11 @@ static inline u32 compute_e820_crc32(struct e820_table *table)#endif /** -* arch_hibernation_header_save - populate the architecture specific part -* of a hibernation image header -* @addr: address to save the data at +* arch_hibernation_header_save - populate the architecture specific part +* of a hibernation image header
But this is not.
If you take the time to clean this up, please rephrase this so it fits into one line.
Quoted 10 lines
arch/x86/power/hibernate.c +3
-1+* @addr: address to save the data at +* @max_size: the maximum size of the data to save +* */ int arch_hibernation_header_save (void *addr,unsigned int max_size) { --2.20.1.7.g153144c