diff options
Diffstat (limited to 'doc/git-annex-unlock.mdwn')
| -rw-r--r-- | doc/git-annex-unlock.mdwn | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/git-annex-unlock.mdwn b/doc/git-annex-unlock.mdwn index 123146836..4b2b809fd 100644 --- a/doc/git-annex-unlock.mdwn +++ b/doc/git-annex-unlock.mdwn @@ -10,7 +10,7 @@ git annex unlock `[path ...]` Normally, the content of annexed files is protected from being changed. Unlocking an annexed file allows it to be modified. This replaces the -symlink for each specified file with a copy of the file's content. +symlink for each specified file with the file's content. You can then modify it and `git annex add` (or `git commit`) to save your changes. @@ -22,6 +22,14 @@ can use `git add` to add a fie to the annex in unlocked form. This allows workflows where a file starts out unlocked, is modified as necessary, and is locked once it reaches its final version. +Normally, unlocking a file requires a copy to be made of its content, +so that its original content is preserved, while the copy can be modified. +To use less space, annex.thin can be set to true; this makes a hard link +to the content be made instead of a copy. (Only when supported by the file +system, and only in repository version 6.) While this can save considerable +disk space, any modification made to a file will cause the old version of the +file to be lost from the local repository. So, enable annex.thin with care. + # OPTIONS * file matching options |