X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/8e92468eae9ac0ab8161a0c71ff6c6a0a8aef07a..51242cc303bd2a1cfb6adc9900388edd212ab08c:/doc/ikiwiki-makerepo.mdwn?ds=sidebyside diff --git a/doc/ikiwiki-makerepo.mdwn b/doc/ikiwiki-makerepo.mdwn index 3fbfbdc82..928440f99 100644 --- a/doc/ikiwiki-makerepo.mdwn +++ b/doc/ikiwiki-makerepo.mdwn @@ -4,29 +4,38 @@ ikiwiki-makerepo - check an ikiwiki srcdir into revision control # SYNOPSIS -ikiwiki-makerepo svn|git|monotone|darcs srcdir repository +ikiwiki-makerepo git|svn|monotone|darcs|cvs srcdir repo -ikiwiki-makerepo bzr|mercurial|darcs 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 created using -any of a variety of revision control systems. +`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 and bzr, the srcdir is converted into a -repository. There is no need to have a separate repository with mercurial -or bzr. +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. + +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 key. +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