Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info
[ikiwiki.git] / doc / rcs / monotone.mdwn
index d68eb1ed59ffd6ec0ffadc04d8beaba6b0c93565..2cfcdfbf54a113d4c06971aaf63233f39780872e 100644 (file)
@@ -1,7 +1,24 @@
-[monotone](http://monotone.ca/) is a distributed revision control system.
-Ikiwiki supports storing a wiki in tla.
+[Monotone](http://monotone.ca/) is a distributed revision control system.
+Ikiwiki supports storing a wiki in a Monotone repository and editing it
+using the [[cgi]] interface. It will use the Monotone logs to generate the
+[[RecentChanges]] page.
 
-This requires the Monotone perl module from the monotone contrib/ directory
-to be installed. In particlar, it needs version 0.03 or higher of that module.
-It is available from the monotone source repository at:
+The monotone support in ikiwiki requires the Monotone perl module to be
+installed. (It's available from the contrib/ directory in the monotone
+source.) In particular, it needs version 0.03 or higher of that module.
+The module is available from the monotone source repository at:
 <http://viewmtn.angrygoats.net/branch/changes/net.venge.monotone>
+
+Monotone support works, but there are still a few minor missing bits (listed here so they are not forgotten):
+
+* Documentation (this page) could be improved.
+
+There is also a mismatch between the way Ikiwiki handles conflicts and the
+way Monotone handles conflicts.  At present, if there is a conflict, then
+Ikiwiki will commit a revision with conflict markers before presenting it
+to the user.  This is ugly, but there is no clean way to fix it at present.
+
+Also note that not all recent ikiwiki features have been implemented in the
+monotone plugin.  At the moment we're missing:
+
+  * [[todo/Untrusted_push_in_Monotone]]