diff options
| author |  Joey Hess <joeyh@joeyh.name> | 2015-12-10 16:12:05 -0400 |
|---|---|---|
| committer | Joey Hess <joeyh@joeyh.name> | 2015-12-10 16:12:48 -0400 |
| commit | 9e0360d0343575a03dce9f90e7d72c0c56deed1a (patch) | |
| tree | ffc0b624843f8f71046c1d1cadc7f27b0d27d77b /doc/git-annex-unlock.mdwn | |
| parent | 23430aeb0b91b10e154e6610d43ae7d40595c2aa (diff) | |
v6 git-annex unlock
Note that the implementation uses replaceFile, so that the actual
replacement of the work tree file is atomic. This seems a good property to
have!
It would be possible for unlock in v6 mode to be run on files that do not
have their content present. However, that would be a behavior change from
before, and I don't see any immediate need to support it, so I didn't
implement it.
Diffstat (limited to 'doc/git-annex-unlock.mdwn')
| -rw-r--r-- | doc/git-annex-unlock.mdwn | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/git-annex-unlock.mdwn b/doc/git-annex-unlock.mdwn index ac8c21185..123146836 100644 --- a/doc/git-annex-unlock.mdwn +++ b/doc/git-annex-unlock.mdwn @@ -11,8 +11,16 @@ 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. -You can then modify it and `git annex add` (or `git commit`) to inject -it back into the annex. +You can then modify it and `git annex add` (or `git commit`) to save your +changes. + +In repositories with annex.version 5 or earlier, unlocking a file is local +to the repository, and is temporary. With version 6, unlocking a file +changes how it is stored in the git repository (from a symlink to a pointer +file), so you can commit it like any other change. Also in version 6, you +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. # OPTIONS |