From 1fabb8083d8d0cd3686e95dc673be889fd99e2ce Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sun, 7 Jun 2009 21:16:41 +0200 Subject: [PATCH] Improve documentation of the remove hooks. --- dss.ggo | 16 +++++++++------- 1 file 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 -- 2.39.2