summaryrefslogtreecommitdiff
path: root/doc/tips
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2016-04-13 13:34:24 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2016-04-13 13:34:24 -0400
commit57b41a1ee78f1181e603b5fd3c563e9b7793620f (patch)
tree3ce89f33b8419d28239069507c7897581a639a1c /doc/tips
parent28bdd2da48e3e7f1326cb34e38f3916bb09772a5 (diff)
smudge: Print a warning when annex.thin is set, as git's smudge interface does not allow honoring that configuration.
Diffstat (limited to 'doc/tips')
-rw-r--r--doc/tips/unlocked_files.mdwn13
1 files changed, 11 insertions, 2 deletions
diff --git a/doc/tips/unlocked_files.mdwn b/doc/tips/unlocked_files.mdwn
index 20605b612..3a74043f0 100644
--- a/doc/tips/unlocked_files.mdwn
+++ b/doc/tips/unlocked_files.mdwn
@@ -135,6 +135,11 @@ make the second copy not be worth keeping:
In situations like these, you may want to avoid the overhead of the second
local copy of unlocked files. There's a config setting for that.
+[[!template id=note text="""
+Note that setting annex.thin only has any effect on systems that support
+hard links. It is supported on Windows, but not on FAT filesystems.
+"""]]
+
git config annex.thin true
After changing annex.thin, you'll want to fix up the work tree to
@@ -142,8 +147,12 @@ match the new setting:
git annex fix
-Note that setting annex.thin only has any effect on systems that support
-hard links. It is supported on Windows, but not on FAT filesystems.
+Unfortunately, git's smudge interface does not let git-annex honor
+the annex.thin configuration when git is checking out a file.
+So, using `git checkout` to check out a different branch, or even
+`git merge` can result in some non-thin files making their way into the
+working tree, and using more disk space. A warning will be printed out in
+this situation. You can always run `git annex fix` to re-thin such files.
## tradeoffs