| Message ID | 20240628091456.57301-1-yang.lee@linux.alibaba.com (mailing list archive) |
|---|---|
| State | Changes Requested, archived |
| Headers | show |
| Series | [-next] mm/treewide: Add missing kernel-doc function comments. | expand |
On Fri, Jun 28, 2024 at 11:15 AM Yang Li <yang.lee@linux.alibaba.com> wrote: > > Add kernel-doc style comments for the pfn_is_nosave and > arch_hibernation_header_save functions. > > Reported-by: Abaci Robot <abaci@linux.alibaba.com> > Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=9453 > Signed-off-by: Yang Li <yang.lee@linux.alibaba.com> > --- > arch/x86/power/hibernate.c | 11 +++++++---- > 1 file changed, 7 insertions(+), 4 deletions(-) > > diff --git a/arch/x86/power/hibernate.c b/arch/x86/power/hibernate.c > index 5b81d19cd114..90f682ff63b1 100644 > --- a/arch/x86/power/hibernate.c > +++ b/arch/x86/power/hibernate.c > @@ -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. > */ > 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. > + * @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 > >
diff --git a/arch/x86/power/hibernate.c b/arch/x86/power/hibernate.c index 5b81d19cd114..90f682ff63b1 100644 --- a/arch/x86/power/hibernate.c +++ b/arch/x86/power/hibernate.c @@ -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) {
Add kernel-doc style comments for the pfn_is_nosave and arch_hibernation_header_save functions. Reported-by: Abaci Robot <abaci@linux.alibaba.com> Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=9453 Signed-off-by: Yang Li <yang.lee@linux.alibaba.com> --- arch/x86/power/hibernate.c | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-)