web commit by XTaran: Example hgrc, some markup, one correction of one of my previous...
[ikiwiki.git] / doc / rcs / mercurial.mdwn
index 020edfc12fa5e27b6b467a6307e1ed9bf4ad1e1b..b4baf07f4a32ba4af0bdfd40e3cd0d3f2657d80e 100644 (file)
@@ -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 = /home/abe/bin/rebuildwiki
+    incoming = /home/abe/bin/rebuildwiki
+
+Do not use `commit` or `precommit` hooks or ikiwiki will run into a dead lock when committing in `$SRCDIR`
+
 See also [[todo/mercurial|todo/mercurial]]