documentation for checkout

This commit is contained in:
Joey Hess 2010-11-07 21:02:25 -04:00
parent 714619d9e8
commit 377bf24d9a
6 changed files with 76 additions and 3 deletions

View file

@ -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

View file

@ -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]]