diff mbox series

doc: power: Add missing parameter description for memory_bm_create

Message ID 20241212161608.24730-1-pvkumar5749404@gmail.com (mailing list archive)
State Changes Requested, archived
Headers show
Series doc: power: Add missing parameter description for memory_bm_create | expand

Commit Message

prabhav kumar Dec. 12, 2024, 4:16 p.m. UTC 
Added the parameter description for bm, gfp_mask and safe_needed
for the function memory_bm_create

Signed-off-by: Prabhav Kumar Vaish <pvkumar5749404@gmail.com>
---
 kernel/power/snapshot.c | 3 +++
 1 file changed, 3 insertions(+)

Comments

Rafael J. Wysocki Dec. 18, 2024, 1:57 p.m. UTC | #1 
On Thu, Dec 12, 2024 at 5:16 PM Prabhav Kumar Vaish
<pvkumar5749404@gmail.com> wrote:
>
> Added the parameter description for bm, gfp_mask and safe_needed
> for the function memory_bm_create
>
> Signed-off-by: Prabhav Kumar Vaish <pvkumar5749404@gmail.com>
> ---
>  kernel/power/snapshot.c | 3 +++
>  1 file changed, 3 insertions(+)
>
> diff --git a/kernel/power/snapshot.c b/kernel/power/snapshot.c
> index 30894d8f0a78..690dd1f467b9 100644
> --- a/kernel/power/snapshot.c
> +++ b/kernel/power/snapshot.c
> @@ -680,6 +680,9 @@ static int create_mem_extents(struct list_head *list, gfp_t gfp_mask)
>
>  /**
>   * memory_bm_create - Allocate memory for a memory bitmap.
> + * @bm: Memory bitmap.
> + * @gfp_mask: GFP mask for the allocation.
> + * @safe_needed: Get pages not used before hibernation (restore only)

This isn't exactly accurate and I'd rather drop the comment entirely.

>   */
>  static int memory_bm_create(struct memory_bitmap *bm, gfp_t gfp_mask,
>                             int safe_needed)
> --
> 2.34.1
>
prabhav kumar Dec. 21, 2024, 5:06 p.m. UTC | #2 
On Wed, Dec 18, 2024 at 7:28 PM Rafael J. Wysocki <rafael@kernel.org> wrote:
>
> On Thu, Dec 12, 2024 at 5:16 PM Prabhav Kumar Vaish
> <pvkumar5749404@gmail.com> wrote:
> >
> > Added the parameter description for bm, gfp_mask and safe_needed
> > for the function memory_bm_create
> >
> > Signed-off-by: Prabhav Kumar Vaish <pvkumar5749404@gmail.com>
> > ---
> >  kernel/power/snapshot.c | 3 +++
> >  1 file changed, 3 insertions(+)
> >
> > diff --git a/kernel/power/snapshot.c b/kernel/power/snapshot.c
> > index 30894d8f0a78..690dd1f467b9 100644
> > --- a/kernel/power/snapshot.c
> > +++ b/kernel/power/snapshot.c
> > @@ -680,6 +680,9 @@ static int create_mem_extents(struct list_head *list, gfp_t gfp_mask)
> >
> >  /**
> >   * memory_bm_create - Allocate memory for a memory bitmap.
> > + * @bm: Memory bitmap.
> > + * @gfp_mask: GFP mask for the allocation.
> > + * @safe_needed: Get pages not used before hibernation (restore only)
>
> This isn't exactly accurate and I'd rather drop the comment entirely.
>
Is it like the comment is inaccurate or the comment is not needed at
the place entirely ?
> >   */
> >  static int memory_bm_create(struct memory_bitmap *bm, gfp_t gfp_mask,
> >                             int safe_needed)
> > --
> > 2.34.1
> >
diff mbox series

Patch

diff --git a/kernel/power/snapshot.c b/kernel/power/snapshot.c
index 30894d8f0a78..690dd1f467b9 100644
--- a/kernel/power/snapshot.c
+++ b/kernel/power/snapshot.c
@@ -680,6 +680,9 @@  static int create_mem_extents(struct list_head *list, gfp_t gfp_mask)
 
 /**
  * memory_bm_create - Allocate memory for a memory bitmap.
+ * @bm: Memory bitmap.
+ * @gfp_mask: GFP mask for the allocation.
+ * @safe_needed: Get pages not used before hibernation (restore only)
  */
 static int memory_bm_create(struct memory_bitmap *bm, gfp_t gfp_mask,
 			    int safe_needed)