summaryrefslogtreecommitdiff
path: root/doc/git-annex.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2011-03-03 16:58:52 -0400
committerGravatar Joey Hess <joey@kitenet.net>2011-03-03 16:58:52 -0400
commit1de12a291891463c6d532a10c74cbda1872c8b9b (patch)
treea2b8559b75aca88d315cd8b2881823f83174d5e6 /doc/git-annex.mdwn
parentb5b78f26ecabdb74c05f8200de5f9d054da5cbae (diff)
document describe command
Diffstat (limited to 'doc/git-annex.mdwn')
-rw-r--r--doc/git-annex.mdwn40
1 files changed, 24 insertions, 16 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 5a0c71059..76f1a577b 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -83,19 +83,6 @@ Many git-annex commands 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.
-* unlock [path ...]
-
- Normally, the content of annexed files is protected from being changed.
- Unlocking a annexed file allows it to be modified. This replaces the
- symlink for each specified file with a copy of the file's content.
- You can then modify it and `git annex add` (or `git commit`) to inject
- it back into the annex.
-
-* edit [path ...]
-
- This is an alias for the unlock command. May be easier to remember,
- if you think of this as allowing you to edit an annexed file.
-
* move [path ...]
When used with the --to option, moves the content of annexed files from
@@ -112,16 +99,37 @@ Many git-annex commands will stage changes for later `git commit` by you.
When used with the --from option, copies the content of annexed files
from the specified repository to the current one.
-* init description
+* unlock [path ...]
- Initializes git-annex with a description of the git repository,
- and sets up `.gitattributes` and the pre-commit hook.
+ Normally, the content of annexed files is protected from being changed.
+ Unlocking a annexed file allows it to be modified. This replaces the
+ symlink for each specified file with a copy of the file's content.
+ You can then modify it and `git annex add` (or `git commit`) to inject
+ it back into the annex.
+
+* edit [path ...]
+
+ This is an alias for the unlock command. May be easier to remember,
+ if you think of this as allowing you to edit an annexed file.
* lock [path ...]
Use this to undo an unlock command if you don't want to modify
the files, or have made modifications you want to discard.
+* init description
+
+ Initializes git-annex with a description of the git repository,
+ and sets up `.gitattributes` and the pre-commit hook.
+
+* describe repository description
+
+ Changes the description of a git repository.
+
+ The repository to describe can be specified by git remote name or
+ by uuid. To change the description of the current repository, use
+ "."
+
* fsck [path ...]
With no parameters, this command checks the whole annex for consistency,