aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-12-04 15:30:06 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-12-04 15:32:47 -0400
commitde1b6019bb6fc1225a2a02cabba8bc3cf193744b (patch)
tree3780c56e7ca43e1f13e928efe8f65a9c11f90591 /doc
parent0e9dbe79e9a738cb8e3873214ad66b9c0aa0a8a8 (diff)
merge clean into smudge command
The git filter config can be used to map the single git-annex command to the 2 actions, and this avoids "git annex clean" being used for this thing, it might have a better use for that name later.
Diffstat (limited to 'doc')
-rw-r--r--doc/git-annex-clean.mdwn36
-rw-r--r--doc/git-annex-smudge.mdwn26
-rw-r--r--doc/git-annex.mdwn8
3 files changed, 23 insertions, 47 deletions
diff --git a/doc/git-annex-clean.mdwn b/doc/git-annex-clean.mdwn
deleted file mode 100644
index 13099a544..000000000
--- a/doc/git-annex-clean.mdwn
+++ /dev/null
@@ -1,36 +0,0 @@
-# NAME
-
-git-annex clean - git filter driver for git-annex
-
-# SYNOPSIS
-
-git annex clean
-
-# DESCRIPTION
-
-When git-annex is used as a git filter driver, this command is run
-by git commands such as `git add`. It generates a file that
-is added to the git repository and points to the git-annex object
-containing the content of a large file.
-
-To configure git to use git-annex as a git filter driver, place the
-following in the .gitattributes file:
-
- * filter=annex
- .* !filter
-
-The annex.largefiles config is consulted to decide if a given file should
-be added to git as-is, or if its content are large enough to need to use
-git-annex.
-
-# SEE ALSO
-
-[[git-annex]](1)
-
-[[git-annex-smudge]](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-smudge.mdwn b/doc/git-annex-smudge.mdwn
index ae28be2c7..a4f458ee5 100644
--- a/doc/git-annex-smudge.mdwn
+++ b/doc/git-annex-smudge.mdwn
@@ -4,26 +4,36 @@ git-annex smudge - git filter driver for git-annex
# SYNOPSIS
-git annex smudge
+git annex smudge [--clean] file
# 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.
+This command lets git-annex be used as a git filter driver which lets
+annexed files in the git repository to be unlocked at all times, instead
+of being symlinks.
-To configure git to use git-annex as a git filter driver, place the
-following in the .gitattributes file:
+The git configuration to use this command as a filter driver is as follows,
+but this is normally set up for you by git-annex init, so you should
+not need to configure it manually:
+
+ [filter "annex"]
+ clean = git-annex smudge --clean %f
+ smudge = git-annex smudge %f
+
+To make git use this filter on all files except for dotfiles, put something
+like the following in the .gitattributes file:
* filter=annex
.* !filter
+When adding a file with `git add`, the annex.largefiles config is
+consulted to decide if a given file should be added to git as-is,
+or if its content are large enough to need to use git-annex.
+
# SEE ALSO
[[git-annex]](1)
-[[git-annex-clean]](1)
-
# AUTHOR
Joey Hess <id@joeyh.name>
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index a8cb73b1b..1a2fd6e67 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -626,11 +626,13 @@ subdirectories).
See [[git-annex-diffdriver]](1) for details.
-* `smudge`, `clean`
+* `smudge`
- These let git-annex be used as a git filter driver.
+ This command lets git-annex be used as a git filter driver, allowing
+ annexed files in the git repository to be unlocked at all times, instead
+ of being symlinks.
- See [[git-annex-smudge]](1) and [[git-annex-clean]](1) for details.
+ See [[git-annex-smudge]](1) for details.
* `remotedaemon`