From 228a724d1d1e1d2f27763bd5f71473acc4d022d9 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Wed, 17 Aug 2011 14:43:38 -0400 Subject: [PATCH] improve docs for init --- doc/git-annex.mdwn | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index 9c202e6689..9d63ca156d 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