X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/f6e01e53fdbfd8369ffd5860424cbb02b4dbc39c..8d7dba2fb274b024e7a8b5d8ce4414d3e5bf7420:/doc/rcs/mercurial.mdwn diff --git a/doc/rcs/mercurial.mdwn b/doc/rcs/mercurial.mdwn index 020edfc12..ebfc35202 100644 --- a/doc/rcs/mercurial.mdwn +++ b/doc/rcs/mercurial.mdwn @@ -2,9 +2,17 @@ system developed by Matt Mackall. Ikiwiki supports storing a wiki in a mercurial repository. -Ikiwiki can run as a post-commit and/or install hook to update a wiki whenever commits or remote pushes +Ikiwiki can run as a `post-commit` and/or `incoming` hook to update a wiki whenever commits or remote pushes come in. When running as a [[cgi]] with Mercurial, ikiwiki automatically commits edited pages, and uses the Mercurial history to generate the [[RecentChanges]] page. +Example for a `.hg/hgrc` file in `$SRCDIR`: + + [hooks] + post-commit = ikiwiki --setup /path/to/ikiwiki.setup --post-commit + incoming = ikiwiki --setup /path/to/ikiwiki.setup --post-commit + +Do not use `commit` or `precommit` hooks or ikiwiki will run into a dead lock when committing in `$SRCDIR`. Also note that `--post-commit` and not `--refresh` must be used to avoid dead locking when editing the pages via CGI interface. + See also [[todo/mercurial|todo/mercurial]]