From: Ben Pfaff <blp@nicira.com>
Date: Mon, 23 Aug 2010 06:13:35 +0000 (-0700)
Subject: daemon: Improve comments.
X-Git-Tag: v1.1.0pre1~42
X-Git-Url: http://git.onelab.eu/?p=sliver-openvswitch.git;a=commitdiff_plain;h=d4db8309c5f22e1fb0201c67b2bf044f652332b7

daemon: Improve comments.

Elsewhere we put the name of command-line options that control global
variables in the comment, so do so here as well.

Also fix a comment typo.
---

diff --git a/lib/daemon.c b/lib/daemon.c
index c8033fbec..cb2f8c206 100644
--- a/lib/daemon.c
+++ b/lib/daemon.c
@@ -36,16 +36,17 @@
 
 VLOG_DEFINE_THIS_MODULE(daemon)
 
-/* Should we run in the background? */
+/* --detach: Should we run in the background? */
 static bool detach;
 
-/* Name of pidfile (null if none). */
+/* --pidfile: Name of pidfile (null if none). */
 static char *pidfile;
 
-/* Create pidfile even if one already exists and is locked? */
+/* --overwrite-pidfile: Create pidfile even if one already exists and is
+   locked? */
 static bool overwrite_pidfile;
 
-/* Should we chdir to "/"? */
+/* --no-chdir: Should we chdir to "/"? */
 static bool chdir_ = true;
 
 /* File descriptor used by daemonize_start() and daemonize_complete(). */
@@ -174,9 +175,9 @@ die_if_already_running(void)
     }
 }
 
-/* If a pidfile has been configured, creates it and stores the running process'
- * pid init.  Ensures that the pidfile will be deleted when the process
- * exits. */
+/* If a pidfile has been configured, creates it and stores the running
+ * process's pid in it.  Ensures that the pidfile will be deleted when the
+ * process exits. */
 static void
 make_pidfile(void)
 {