Re: [PATCH -mm] PM: Separate hibernation code from suspend code

["Rafael J. Wysocki" <rjw@sisk.pl>]

On Friday, 4 May 2007 19:22, Satyam Sharma wrote:
> Trivial suggestions:
> 
> On 5/4/07, Rafael J. Wysocki <rjw@sisk.pl> wrote:
> > --- linux-2.6.21.orig/include/linux/suspend.h   2007-05-02 22:08:58.000000000 +0200
> > +++ linux-2.6.21/include/linux/suspend.h        2007-05-03 15:22:24.000000000 +0200
> > [...]
> > +/**
> > + * hibernation_set_ops - set the global hibernate operations
> > + * @ops: the hibernation operations to use in subsequent hibernation transitions
> > + */
> > +extern void hibernation_set_ops(struct hibernation_ops *ops);
> 
> Comment must go near code, not with prototype in header.
> 
> > +/**
> > + * hibernate - hibernate the system
> > + */
> > +extern int hibernate(void);
> 
> Pointless comment. You've already written a doc-book comment in the
> code for this function anyway, so could just as well remove this.

The appended patch fixes these problems.

Greetings,
Rafael

---
From: Rafael J. Wysocki <rjw@sisk.pl>

Remove unnecessary comments in include/linux/suspend.h and  add a comment
describing hibernation_set_ops() in kernel/power/disk.c .

Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
---
 include/linux/suspend.h |    8 --------
 kernel/power/disk.c     |    5 +++++
 2 files changed, 5 insertions(+), 8 deletions(-)

Index: linux-2.6.21/include/linux/suspend.h
===================================================================
--- linux-2.6.21.orig/include/linux/suspend.h	2007-05-05 00:39:53.000000000 +0200
+++ linux-2.6.21/include/linux/suspend.h	2007-05-05 00:43:39.000000000 +0200
@@ -58,15 +58,7 @@ extern void swsusp_set_page_free(struct 
 extern void swsusp_unset_page_free(struct page *);
 extern unsigned long get_safe_page(gfp_t gfp_mask);
 
-/**
- * hibernation_set_ops - set the global hibernate operations
- * @ops: the hibernation operations to use in subsequent hibernation transitions
- */
 extern void hibernation_set_ops(struct hibernation_ops *ops);
-
-/**
- * hibernate - hibernate the system
- */
 extern int hibernate(void);
 #else
 static inline void register_nosave_region(unsigned long b, unsigned long e) {}
Index: linux-2.6.21/kernel/power/disk.c
===================================================================
--- linux-2.6.21.orig/kernel/power/disk.c	2007-05-05 00:40:02.000000000 +0200
+++ linux-2.6.21/kernel/power/disk.c	2007-05-05 00:43:32.000000000 +0200
@@ -47,6 +47,11 @@ enum {
 
 struct hibernation_ops *hibernation_ops;
 
+/**
+ * hibernation_set_ops - set the global hibernate operations
+ * @ops: the hibernation operations to use in subsequent hibernation transitions
+ */
+
 void hibernation_set_ops(struct hibernation_ops *ops)
 {
 	if (ops && !(ops->prepare && ops->enter && ops->finish)) {