From: Mike Snitzer <snitzer@redhat.com>
Date: Wed, 6 Jan 2010 19:08:58 +0000 (+0000)
Subject: . update documentation for --poll in the vgchange and lvchange man pages
X-Git-Tag: old-v2_02_57~42
X-Git-Url: https://sourceware.org/git/?a=commitdiff_plain;h=9788b9d7a9fa63898cf9f6b28edd75e7dea4d1ff;p=lvm2.git

. update documentation for --poll in the vgchange and lvchange man pages
. add high-level --poll FIXMEs to vgchange.c and lvchange.c
---

diff --git a/man/lvchange.8.in b/man/lvchange.8.in
index c18aec2ec..08a83c498 100644
--- a/man/lvchange.8.in
+++ b/man/lvchange.8.in
@@ -64,12 +64,12 @@ the failure is handled according to
 set in \fBlvm.conf\fP.
 .TP
 .I \-\-poll y|n
-Controls whether or not a logical volume's progress is polled.  It may
-not be appropriate to immediately poll the progress of a logical
-volume's transformation when it is activated (for example, when merging
-a snapshot into the root FS).  The progress polling of an incomplete
-pvmove or lvconvert can be deferred using \fB--poll n\fP and restarted
-using \fB--poll y\fP.
+Without polling a logical volume's backgrounded transformation process
+will never complete.  If there is an incomplete pvmove or lvconvert (for
+example, on rebooting after a crash), use \fB--poll y\fP to restart the
+process from its last checkpoint.  However, it may not be appropriate to
+immediately poll a logical volume when it is activated, use \fB--poll
+n\fP to defer and then \fB--poll y\fP to restart the process.
 .TP
 .I \-\-noudevsync
 Disable udev synchronisation. The
diff --git a/man/vgchange.8.in b/man/vgchange.8.in
index ad0982339..5013c1e88 100644
--- a/man/vgchange.8.in
+++ b/man/vgchange.8.in
@@ -89,12 +89,12 @@ set in
 .BR lvm.conf (5).
 .TP
 .BR \-\-poll " " { y | n }
-Controls whether or not a logical volume's progress is polled.  It may
-not be appropriate to immediately poll the progress of a logical
-volume's transformation when it is activated (for example, when merging
-a snapshot into the root FS).  The progress polling of an incomplete
-pvmove or lvconvert can be deferred using \fB--poll n\fP and restarted
-using \fB--poll y\fP.
+Without polling a logical volume's backgrounded transformation process
+will never complete.  If there is an incomplete pvmove or lvconvert (for
+example, on rebooting after a crash), use \fB--poll y\fP to restart the
+process from its last checkpoint.  However, it may not be appropriate to
+immediately poll a logical volume when it is activated, use \fB--poll
+n\fP to defer and then \fB--poll y\fP to restart the process.
 .TP
 .BR \-\-noudevsync
 Disable udev synchronisation. The
diff --git a/tools/lvchange.c b/tools/lvchange.c
index 11e128a56..5118e5108 100644
--- a/tools/lvchange.c
+++ b/tools/lvchange.c
@@ -596,6 +596,13 @@ static int lvchange_single(struct cmd_context *cmd, struct logical_volume *lv,
 					    (is_static() || arg_count(cmd, ignoremonitoring_ARG)) ?
 					    DMEVENTD_MONITOR_IGNORE : DEFAULT_DMEVENTD_MONITOR));
 
+	/*
+	 * FIXME: DEFAULT_BACKGROUND_POLLING should be "unspecified".
+	 * If --poll is explicitly provided use it; otherwise polling
+	 * should only be started if the LV is not already active. So:
+	 * 1) change the activation code to say if the LV was actually activated
+	 * 2) make polling of an LV tightly coupled with LV activation
+	 */
 	init_background_polling(arg_int_value(cmd, poll_ARG,
 					      DEFAULT_BACKGROUND_POLLING));
 
diff --git a/tools/vgchange.c b/tools/vgchange.c
index cd692b34b..e425f14ca 100644
--- a/tools/vgchange.c
+++ b/tools/vgchange.c
@@ -548,6 +548,13 @@ static int vgchange_single(struct cmd_context *cmd, const char *vg_name,
 					    (is_static() || arg_count(cmd, ignoremonitoring_ARG)) ?
 					    DMEVENTD_MONITOR_IGNORE : DEFAULT_DMEVENTD_MONITOR));
 
+	/*
+	 * FIXME: DEFAULT_BACKGROUND_POLLING should be "unspecified".
+	 * If --poll is explicitly provided use it; otherwise polling
+	 * should only be started if the LV is not already active. So:
+	 * 1) change the activation code to say if the LV was actually activated
+	 * 2) make polling of an LV tightly coupled with LV activation
+	 */
 	init_background_polling(arg_int_value(cmd, poll_ARG,
 					      DEFAULT_BACKGROUND_POLLING));