diff options
| author |  Joey Hess <joey@kitenet.net> | 2011-08-17 14:43:38 -0400 |
|---|---|---|
| committer | Joey Hess <joey@kitenet.net> | 2011-08-17 14:44:31 -0400 |
| commit | 228a724d1d1e1d2f27763bd5f71473acc4d022d9 (patch) | |
| tree | 970a692095857820eae7a7ada9ed9f1dbc428dec | |
| parent | 32f27cc3e839a3c243641b953fd4bd0f15dda08a (diff) | |
improve docs for init
| -rw-r--r-- | doc/git-annex.mdwn | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index 9c202e668..9d63ca156 100644 --- a/doc/git-annex.mdwn +++ b/doc/git-annex.mdwn @@ -121,8 +121,14 @@ Many git-annex commands will stage changes for later `git commit` by you. * init description - Initializes git-annex with a description of the git repository, - and sets up the pre-commit hook. + Initializes git-annex with a description of the git repository. + + Until a repository (or one of its remotes) has been initialized, + git-annex will refuse to operate on it, to avoid accidentially + using it in a repository that was not intended to have an annex. + + It's useful, but not mandatory, to initialize each new clone + of a repository with its own description. * describe repository description |