From 42bdaaa5d7c273afa63f954592602f9c379b6808 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Thu, 12 Sep 2019 13:58:12 -0400 Subject: [PATCH] improve docs for v7 unlock --- doc/git-annex-unlock.mdwn | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/git-annex-unlock.mdwn b/doc/git-annex-unlock.mdwn index 32580ec6c5..3dea02b3ee 100644 --- a/doc/git-annex-unlock.mdwn +++ b/doc/git-annex-unlock.mdwn @@ -11,13 +11,15 @@ 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 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 symlink to a pointer file), so this command will make a change that you 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 the beginning. This allows workflows where a file starts out unlocked, is modified as necessary, and is locked once it reaches its final version.