documentation for checkout

1 files changed, 13 insertions, 1 deletions

diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 856b474e0..80680820f 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -81,6 +81,13 @@ Many git-annex subcommands will stage changes for later `git commit` by you.
   git-annex may refuse to drop content if the backend does not think
   it is safe to do so, typically because of the setting of annex.numcopies.
 
+* checkout [path ...]
+
+  Checks out annexed files so they can be modified. This replaces the
+  symlink for each specified file with a copy of the file content.
+  When you `git commit`, the file, the new content is injected back into
+  the annex.
+
 * move [path ...]
 
   When used with the --to option, moves the content of annexed files from
@@ -95,6 +102,11 @@ Many git-annex subcommands will stage changes for later `git commit` by you.
   and sets up `.gitattributes` and the pre-commit hook.
   This is an optional, but recommended step.
 
+* uncheckout [path ...]
+
+  Use this to undo a checkout command if you don't want to modify
+  the checked out files, or have made modifications you want to discard.
+
 * unannex [path ...]
 
   Use this to undo an accidental add command. This is not the command you
@@ -110,7 +122,7 @@ Many git-annex subcommands will stage changes for later `git commit` by you.
 * pre-commit [path ...]
 
   Fixes up symlinks that are staged as part of a commit, to ensure they
-  point to annexed content. 
+  point to annexed content. Also handles committing checked-out files.
 
   This is meant to be called from git's pre-commit hook. `git annex init`
   automatically creates a pre-commit hook using this.