diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/assistant/thanks.mdwn | 2 | ||||
| -rw-r--r-- | doc/direct_mode.mdwn | 32 | ||||
| -rw-r--r-- | doc/git-annex.mdwn | 7 |
3 files changed, 15 insertions, 26 deletions
diff --git a/doc/assistant/thanks.mdwn b/doc/assistant/thanks.mdwn index 7a660f8ca..c9ccb4bf9 100644 --- a/doc/assistant/thanks.mdwn +++ b/doc/assistant/thanks.mdwn @@ -47,7 +47,7 @@ Ian McEwen, asc, Paul Tagliamonte, Sherif Abouseda, Igor Támara, Anne Wind, Mesar Hameed, Brandur K. Holm Petersen, Takahiro Inoue, Kai Hendry, Stephen Youndt, Lee Roberson, Ben Strawbridge, Andrew Greenberg, Alfred Adams Andrew, Aaron De Vries, Monti Knazze, Jorge Canseco, Hamish, Mark Eichin, -Sherif Abouseda, Ben Strawbridge +Sherif Abouseda, Ben Strawbridge, chee rabbits, Pedro Côrte-Real And special thanks to Kevin McKenzie, who also gave me a login to a Mac OSX machine, which has proven invaluable, and Jimmy Tang who has helped diff --git a/doc/direct_mode.mdwn b/doc/direct_mode.mdwn index d1f9ae73e..9abaf5207 100644 --- a/doc/direct_mode.mdwn +++ b/doc/direct_mode.mdwn @@ -34,33 +34,19 @@ any time). To do so: ## use a direct mode repository -Perhaps the best way to use a direct mode repository is with the git-annex -assistant. +You can use most git-annex commands as usual in a direct mode repository. +A few commands don't work in direct mode, and will refuse to do anything. -Otherwise, the main command that's used in direct mode repositories is -`git annex sync`. This automatically adds new files, commits all -changed files to git, pushes them out, pulls down any changes, etc. +Direct mode also works well with the git-annex assistant. -`git annex add` and some other commands are not yet supported in direct -mode repositories. Feel free to try any git annex command though; ones that -don't support direct mode will refuse to do anything. - -You can use `git commit --staged`. (But not `git commit -a` .. It'll commit -whole large files into git!) - -You can use `git log` and other git query commands. +You can use `git commit --staged`. But not `git commit -a` .. It'll +commit whole large files into git! ## what doesn't work in direct mode -In general git-annex commands will only work in direct mode repositories on -files whose content is not present. That's because such files are still -represented as symlinks, which git-annex commands know how to operate on. -So, `git annex get` works, but `git annex drop` and `git annex move` don't, -and things like `git annex status` show incomplete information. - -It's technically possible to make all git-annex commands work in direct -mode repositories, so this might change. Check back to this page to see -current status about what works and what doesn't. +`git annex status` show incomplete information. A few other commands, +like `git annex unlock` don't make sense in direct mode and will refuse to +run. As for git commands, you can probably use some git working tree manipulation commands, like `git checkout` and `git revert` in useful @@ -70,4 +56,4 @@ had of something, it'll be lost. This is one reason it's wise to make git-annex untrust your direct mode repositories. Still, you can lose data using these sort of git commands, so -use extreme caution. +use extreme caution. diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index 6aaea6753..7294fb277 100644 --- a/doc/git-annex.mdwn +++ b/doc/git-annex.mdwn @@ -269,11 +269,14 @@ subdirectories). * direct Switches a repository to use direct mode, where rather than symlinks to - files, the files are directly present in the repository. Note that most git - commands and some git-annex commands will not work in direct mode. + files, the files are directly present in the repository. As part of the switch to direct mode, any changed files will be committed. + Note that git commands that operate on the work tree are often unsafe to + use in direct mode repositories, and can result in data loss or other + bad behavior. + * indirect Switches a repository back from direct mode to the default, indirect mode. |