summaryrefslogtreecommitdiff
path: root/doc/git-annex-smudge.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-12-04 13:02:56 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-12-04 13:03:39 -0400
commit13ae7961f9ff251ac4c0d92823ebb7cf6577ce33 (patch)
treef15423500aff7434a7b80b5824e24b40f77a34cd /doc/git-annex-smudge.mdwn
parent01bf5a9ec04c2e6711e33d6b43562528d3ab7ae4 (diff)
skeleton smudge/clean filters
Diffstat (limited to 'doc/git-annex-smudge.mdwn')
-rw-r--r--doc/git-annex-smudge.mdwn31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/git-annex-smudge.mdwn b/doc/git-annex-smudge.mdwn
new file mode 100644
index 000000000..ae28be2c7
--- /dev/null
+++ b/doc/git-annex-smudge.mdwn
@@ -0,0 +1,31 @@
+# NAME
+
+git-annex smudge - git filter driver for git-annex
+
+# SYNOPSIS
+
+git annex smudge
+
+# DESCRIPTION
+
+When git-annex is used as a git filter driver, this command is run
+by git commands such as `git checkout` and outputs the content of annexed
+objects that pointer files point to.
+
+To configure git to use git-annex as a git filter driver, place the
+following in the .gitattributes file:
+
+ * filter=annex
+ .* !filter
+
+# SEE ALSO
+
+[[git-annex]](1)
+
+[[git-annex-clean]](1)
+
+# AUTHOR
+
+Joey Hess <id@joeyh.name>
+
+Warning: Automatically converted into a man page by mdwn2man. Edit with care.