mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

improve docs for v7 unlock

Browse source
This commit is contained in:
Joey Hess 2019-09-12 13:58:12 -04:00
parent 4a4e08e123
commit 42bdaaa5d7
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/git-annex-unlock.mdwn
View file

@ -11,13 +11,15 @@ git annex unlock `[path ...]`
Normally, the content of annexed files is protected from being changed. Normally, the content of annexed files is protected from being changed.
Unlocking an annexed file allows it to be modified. This replaces the Unlocking an annexed file allows it to be modified. This replaces the
symlink for each specified file with 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.
Unlocking a file changes how it is stored in the git repository (from a Unlocking a file changes how it is stored in the git repository (from a
symlink to a pointer file), so this command will make a change that you symlink to a pointer file), so this command will make a change that you
can commit. can commit.
The content of an unlocked file is still stored in git-annex, not git,
and when you commit modifications to the file, the modifications will also
be stored in git-annex, with only the pointer file stored in git.
If you use `git add` to add a file, it will be added in unlocked form from If you use `git add` to add a file, it will be added in unlocked form from
the beginning. This allows workflows where a file starts out unlocked, is the beginning. This allows workflows where a file starts out unlocked, is
modified as necessary, and is locked once it reaches its final version. modified as necessary, and is locked once it reaches its final version.