documentation for checkout

2 files changed, 20 insertions, 0 deletions

diff --git a/doc/todo/backendSHA1.mdwn b/doc/todo/backendSHA1.mdwn
index fa9728af6..44df406de 100644
--- a/doc/todo/backendSHA1.mdwn
+++ b/doc/todo/backendSHA1.mdwn
@@ -3,3 +3,5 @@ This backend is not finished.
 In particular, while files can be added using it, git-annex will not notice
 when their content changes, and will not create a new key for the new sha1
 of the net content.
+
+[[done]]; use checkout subcommand
diff --git a/doc/todo/checkout.mdwn b/doc/todo/checkout.mdwn
index 70d31a5ff..50da2d62e 100644
--- a/doc/todo/checkout.mdwn
+++ b/doc/todo/checkout.mdwn
@@ -3,3 +3,21 @@ file's content, with a copy of the file. Once you've checked a file out,
 you can edit it, and `git commit` it. On commit, git-annex will detect
 if the file has been changed, and if it has, `add` its content to the
 annex.
+
+> Internally, this will need to store the original symlink to the file, in 
+> `.git/annex/checkedout/$filename`.
+> 
+> * git-annex uncheckout moves that back
+> * git-annex pre-commit hook checks each file being committed to see if
+>   it has a symlink there, and if so, removes the symlink and adds the new
+>   content to the annex. 
+> 
+> And it seems the file content should be copied, not moved or hard linked:
+> 
+> * Makes sure other annexes can find it if transferring it from
+>   this annex.
+> * Ensures it's always available for uncheckout.
+> * Avoids the last copy of a file's content being lost when
+>   the checked out file is modified.
+
+[[done]]