summaryrefslogtreecommitdiff
path: root/doc/git-annex.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2013-10-28 16:56:01 -0400
committerGravatar Joey Hess <joey@kitenet.net>2013-10-28 16:56:01 -0400
commit39163cb024b49a0214c104d4fe21b778bbd63eaa (patch)
treed6ff5978d5cac09dac14231a5d423a6784102dfa /doc/git-annex.mdwn
parentd93d453c3c4d41d446970db21b1d504b3690adb6 (diff)
unannex: New, much slower, but more safe behavior
Copies files out of the annex. This avoids an unannex of one file breaking other files that link to the same content. Also, it means that the content remains in the annex using up space until cleaned up with "git annex unused". (The behavior of unannex --fast has not changed; it still hard links to content in the annex. --fast was not made the default because it is potentially unsafe; editing such a hard linked file can unexpectedly change content stored in the annex.)
Diffstat (limited to 'doc/git-annex.mdwn')
-rw-r--r--doc/git-annex.mdwn14
1 files changed, 9 insertions, 5 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 8d27bd7a7..8ff0b7962 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -673,16 +673,20 @@ subdirectories).
* `unannex [path ...]`
- Use this to undo an accidental `git annex add` command. You can use
- `git annex unannex` to move content out of the annex at any point,
- even if you've already committed it.
+ Use this to undo an accidental `git annex add` command. It puts the
+ file back how it was before the add.
+
+ Note that for safety, the content of the file remains in the annex (as a
+ hard link), until you use `git annex unused` and `git annex dropunused`.
This is not the command you should use if you intentionally annexed a
file and don't want its contents any more. In that case you should use
`git annex drop` instead, and you can also `git rm` the file.
- In `--fast` mode, this command leaves content in the annex, simply making
- a hard link to it.
+ Normally this does a slow copy of the file. In `--fast` mode, it
+ instead makes a hard link from the file to the content in the annex.
+ But use --fast mode with caution, because editing the file will
+ change the content in the annex.
* `uninit`