summaryrefslogtreecommitdiff
path: root/doc/git-annex.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2012-03-04 16:00:24 -0400
committerGravatar Joey Hess <joey@kitenet.net>2012-03-04 19:12:58 -0400
commit52e88f3ebf974c3802e951e17593ce5768c04b92 (patch)
treeed87ada9f7e15dcb295ae0310fbf731175cf101b /doc/git-annex.mdwn
parentfba66c55ed3e060aae90fe90b5ea8e3ec4132bb7 (diff)
add remote start and stop hooks
Locking is used, so that, if there are multiple git-annex processes using a remote concurrently, the stop hook is only run by the last process that uses it.
Diffstat (limited to 'doc/git-annex.mdwn')
-rw-r--r--doc/git-annex.mdwn15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 85d972259..a941d4420 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -627,6 +627,21 @@ Here are all the supported configuration settings.
This allows varying the cost based on eg, the current network. The
cost-command can be any shell command line.
+* `remote.<name>.annex-start-command`
+
+ A command to run when git-annex begins to use the remote. This can
+ be used to, for example, mount the directory containing the remote.
+
+ The command may be run repeatedly in multiple git-annex processes
+ are running concurrently.
+
+* `remote.<name>.annex-stop-command`
+
+ A command to run when git-annex is done using the remote.
+
+ The command will only be run once *all* running git-annex processes
+ are finished using the remote.
+
* `remote.<name>.annex-ignore`
If set to `true`, prevents git-annex