diff options
| author |  Joey Hess <joeyh@joeyh.name> | 2016-04-13 13:34:24 -0400 |
|---|---|---|
| committer | Joey Hess <joeyh@joeyh.name> | 2016-04-13 13:34:24 -0400 |
| commit | 57b41a1ee78f1181e603b5fd3c563e9b7793620f (patch) | |
| tree | 3ce89f33b8419d28239069507c7897581a639a1c /doc | |
| parent | 28bdd2da48e3e7f1326cb34e38f3916bb09772a5 (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')
| -rw-r--r-- | doc/git-annex.mdwn | 4 | ||||
| -rw-r--r-- | doc/tips/unlocked_files.mdwn | 13 |
2 files changed, 13 insertions, 4 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index 65b5dc701..b9d9221fd 100644 --- a/doc/git-annex.mdwn +++ b/doc/git-annex.mdwn @@ -932,8 +932,8 @@ Here are all the supported configuration settings. Set this to `true` to make unlocked files be a hard link to their content in the annex, rather than a second copy. (Only when supported by the file system, and only in repository version 6.) This can save considerable - disk space, but modification made to a file will lose the local (and - possibly only) copy of the old version. So, enable with care. + disk space, but when a modification is made to a file, you will lose the + local (and possibly only) copy of the old version. So, enable with care. After setting (or unsetting) this, you should run `git annex fix` to fix up the annexed files in the work tree to be hard links (or copies). 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 |