X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/47040e4e173254bb3f2f5126163725e8e2ae5f96..c0d0bead6a06a33011061a78b166270a680f714a:/doc/ikiwiki-makerepo.mdwn diff --git a/doc/ikiwiki-makerepo.mdwn b/doc/ikiwiki-makerepo.mdwn index e76b3f318..928440f99 100644 --- a/doc/ikiwiki-makerepo.mdwn +++ b/doc/ikiwiki-makerepo.mdwn @@ -4,18 +4,38 @@ ikiwiki-makerepo - check an ikiwiki srcdir into revision control # SYNOPSIS -ikiwiki-makerepo svn|git srcdir repository +ikiwiki-makerepo git|svn|monotone|darcs|cvs srcdir repo -ikiwiki-makerepo mercurial srcdir +ikiwiki-makerepo bzr|mercurial srcdir # 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 svn and cvs, the `repo` is the centralized repository, and the `srcdir` +is a checkout of it. + +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