clarified and largely rewritten

[git.ikiwiki.info.git] / doc / ikiwiki-makerepo.mdwn

diff --git a/doc/ikiwiki-makerepo.mdwn b/doc/ikiwiki-makerepo.mdwn
index d5034b2c724da9780890985351d1b7fc5c59b6a4..61ca8e6fa82483deb17a455e4eb55aa443bfae6b 100644 (file)
--- a/doc/ikiwiki-makerepo.mdwn
+++ b/doc/ikiwiki-makerepo.mdwn
@@ -4,28 +4,38 @@ ikiwiki-makerepo - check an ikiwiki srcdir into revision control
 
 # SYNOPSIS
 
 
 # SYNOPSIS
 

-ikiwiki-makerepo svn|git|monotone|darcs srcdir repository
+ikiwiki-makerepo git|svn|monotone|darcs|cvs srcdir repo

 
 

-ikiwiki-makerepo mercurial|darcs srcdir
+ikiwiki-makerepo bzr|mercurial srcdir

 
 # DESCRIPTION
 
 
 # DESCRIPTION
 

-`ikiwiki-makerepo` injects a `srcdir` directory, containing an ikiwiki wiki,
-into a `repository` that it creates. The repository can be a svn, git, or
-mercurial repository.
+`ikiwiki-makerepo` injects an existing `srcdir` directory, containing
+sources for an ikiwiki wiki, into revision control. It is rarely
+run directly; consider using `ikiwiki -setup /etc/ikiwiki/wiki.setup` instead
+to set up a wiki.

 
 

-Note that for mercurial, the srcdir is converted into a mercurial
-repository. There is no need to have a separate repository with mercurial.
+For git, the `repo` is created as a bare git repository, and the srcdir is
+made into a clone of it. (monotone and darcs are similar.)

 
 

-For darcs, the second (one-argument) form turns the given srcdir into a
-darcs master repository with the (new) srcdir inside. Adjust your ikiwiki.setup
-according to the command output! Also, the master repo's apply hook will be
-preconfigured to call a (hypothetical) ikiwiki wrapper. The command
-reports the relevant file. Adjust it as needed or remove it if you don't use
-the cgi script.
+For svn and cvs, the `repo` is the centralized repository, and the `srcdir`
+is a checkout of it.

 
 

-Note that for monotone, you are assumed to already have run "mtn genkey" to generate
-key.
+For for mercurial and bzr, the srcdir is the only repository set up.
+
+For darcs, the master repo's apply hook will be preconfigured to call a
+ikiwiki wrapper.
+
+Note that for monotone, you are assumed to already have run "mtn genkey"
+to generate a key.
+
+# EXAMPLE 
+
+`ikiwiki-makerepo git /srv/web/wiki /srv/git/wiki.git/`
+
+This creates a bare repository `/srv/git/wiki.git/`,
+and sets up `/srv/web/wiki` to be a clone of it, committing
+any files that already exist in that directory.

 
 # AUTHOR
 
 
 # AUTHOR