summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndre Noll <maan@systemlinux.org>2009-06-07 21:16:41 +0200
committerAndre Noll <maan@systemlinux.org>2009-06-07 21:16:41 +0200
commit1fabb8083d8d0cd3686e95dc673be889fd99e2ce (patch)
tree3ac215284079c83f6b17e8dc5d97e966241b5f5f
parent360bcc95d588232d8c81e028464d9e23b356a193 (diff)
Improve documentation of the remove hooks.
-rw-r--r--dss.ggo16
1 files changed, 9 insertions, 7 deletions
diff --git a/dss.ggo b/dss.ggo
index 9c687f4..3133d03 100644
--- a/dss.ggo
+++ b/dss.ggo
@@ -283,9 +283,11 @@ option "pre-remove-hook" -
string typestr="command"
optional
details="
- Execute this command before removing a snapshot. If this
- command returns with a non-zero exit status, no snapshot is
- being removed and the operation is retried later.
+ Execute this command before removing a snapshot. The full
+ path to the snapshot about to be deleted is passed to the
+ command as the first argument. If the command returns with
+ a non-zero exit status, no snapshot is being removed and the
+ operation is retried later.
For example, one might want to execute a script that checks
whether the snapshot to be deleted is currently used by
@@ -302,10 +304,10 @@ option "post-remove-hook" -
string typestr="command"
optional
details="
- Execute this after a snapshot has successfully been
- removed. The full path of the removed snapshot is
- passed to the hook as the first argument. The exit code of
- this hook is ignored.
+ Execute this after a snapshot has successfully been removed. As
+ for the pre-remove hook, the full path of the removed snapshot
+ is passed to the hook as the first argument. The exit code
+ of this hook is ignored.
"
option "exit-hook" e