aboutsummaryrefslogtreecommitdiff
path: root/doc/git-annex-pre-commit.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-03-25 12:09:49 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-03-25 12:09:49 -0400
commitf77d5bcc56a4692f321896dedab75c6ec32f967a (patch)
treeb57bf5d62fe1651502917f13d093ce9b4d79a6c3 /doc/git-annex-pre-commit.mdwn
parent00c09b2038611de97c26f4141a748f08cc8fe570 (diff)
finished splitting out man pages for all commands
Diffstat (limited to 'doc/git-annex-pre-commit.mdwn')
-rw-r--r--doc/git-annex-pre-commit.mdwn27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/git-annex-pre-commit.mdwn b/doc/git-annex-pre-commit.mdwn
new file mode 100644
index 000000000..e0f6fdb2a
--- /dev/null
+++ b/doc/git-annex-pre-commit.mdwn
@@ -0,0 +1,27 @@
+# NAME
+
+git-annex pre-commit - run by git pre-commit hook
+
+# SYNOPSIS
+
+git annex `[path ...]`
+
+# DESCRIPTION
+
+This is meant to be called from git's pre-commit hook. `git annex init`
+automatically creates a pre-commit hook using this.
+
+Fixes up symlinks that are staged as part of a commit, to ensure they
+point to annexed content. Also handles injecting changes to unlocked
+files into the annex. When in a view, updates metadata to reflect changes
+made to files in the view.
+
+# SEE ALSO
+
+[[git-annex]](1)
+
+# AUTHOR
+
+Joey Hess <id@joeyh.name>
+
+Warning: Automatically converted into a man page by mdwn2man. Edit with care.