summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/git-annex-post-receive.mdwn34
-rw-r--r--doc/git-annex.mdwn7
2 files changed, 41 insertions, 0 deletions
diff --git a/doc/git-annex-post-receive.mdwn b/doc/git-annex-post-receive.mdwn
new file mode 100644
index 000000000..9fa9e314d
--- /dev/null
+++ b/doc/git-annex-post-receive.mdwn
@@ -0,0 +1,34 @@
+# NAME
+
+git-annex post-receive - run by git post-receive hook
+
+# SYNOPSIS
+
+git annex post-receive
+
+# DESCRIPTION
+
+This is meant to be called from git's post-receive hook. `git annex init`
+automatically creates a post-receive hook using this.
+
+When a repository is configured with receive.denyCurrentBranch=updateInstead,
+pushes to the repository update its work tree. However, that does not work
+for repositories that use direct mode or have an adjusted branch checked
+out. The hook updates the work tree when run in such a repository,
+the same as running `git-annex merge` would.
+
+# SEE ALSO
+
+[[git-annex]](1)
+
+[[git-annex-direct]](1)
+
+[[git-annex-adjust]](1)
+
+[[git-annex-merge]](1)
+
+# AUTHOR
+
+Joey Hess <id@joeyh.name>
+
+Warning: Automatically converted into a man page by mdwn2man. Edit with care.
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 63f58d9e4..525900d92 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -542,6 +542,13 @@ subdirectories).
See [[git-annex-pre-commit]](1) for details.
+* `post-receive`
+
+ This is meant to be called from git's post-receive hook. `git annex init`
+ automatically creates a post-receive hook using this.
+
+ See [[git-annex-post-receive]](1) for details.
+
* `lookupkey [file ...]`
Looks up key used for file.