web commit by http://willu.myopenid.com/: Respond with details of monotone plugin...
[ikiwiki.git] / doc / bugs / Monotone_rcs_support.mdwn
1 #Ikiwiki plugin for the Monotone revision control system.
2
3 I've just made a patch to the ikiwiki code that allows it to use the [[rcs/Monotone]] revision control system.  It is available at:
4
5 <http://www.cse.unsw.edu.au/~willu/monotone-ikiwiki.diff>
6
7 At the moment it is basically complete.  At present rcs_notify() is implemeted but untested, the rest is implemented and tested.
8
9 The current version of the patch handles conflicts through the web interface.  It is still not perfect as it will break if there is a rename that conflicts with a web change (but so will the other Rcs plugins I think).  It also commits a revision with conflict markers if there is a conflict requiring such markers... ick.
10
11 Note: This patch requires a rather recent Monotone perl module (18 August 2007 or later).  It is available from the monotone repository here: <http://viewmtn.angrygoats.net/branch/changes/net.venge.monotone>.
12
13 > The setup instructions to add 40 lines of code to monotonerc is pretty frightning stuff.
14 > Is there some way this can be automated? --[[Joey]]
15
16 >> I've committed a bunch of this to monotone so that in future it could be removed.
17 >> I've also just fixed this so it is in a separate, automagically generated, rc file.
18
19 >>> Fair enough. Didn't realize you were a monotone committer. :-)
20
21 >>>> I am, but still a little newish.  Feedback is good.  In particular, this is my first major bit of PERL.
22
23 > Having rcs_commit return a warning message when there's an unresolved conflict
24 > isn't right; that message will populate the page edit box. You might want
25 > to use the error() function here?
26
27 >> It should never reach that case, so I have changed that to error.
28
29 > There'an incomplete comment ending with "note, this relies on the fact that"
30
31 >> erg... sorry, fixed.
32
33 [[tag patch]]
34
35 >> I've [[accepted|done]] this patch, thank you! 
36
37 >>> Thanks for committing it.  I hate keeping my own diffs. :)
38
39 >> I did make a few changes. Please review, and make sure it still works
40 >> (a test case like we have for some of the other RCSes would be nice..)
41
42 >>> Tested.  It still works at least as well as it did.  I'll try to get to a test case soon.
43 >>> In checking the source I noticed a few bogus comments I left in when editing,
44 >>> and a bug in page adding.
45 >>> Here is a small patch for them:
46
47     Index: IkiWiki/Rcs/monotone.pm
48     ===================================================================
49     --- IkiWiki/Rcs/monotone.pm (revision 4195)
50     +++ IkiWiki/Rcs/monotone.pm (working copy)
51     @@ -245,6 +245,9 @@
52                 # FIXME: use of $file in these backticks is not wise from a
53                 # security POV. Probably safe, but should be avoided
54                 # anyway.
55     +           # At the moment the backticks are used because the above call using the automate
56     +           # interface was failing.  When that bug in monotone is fixed, we should switch
57     +           # back.
58                 my $diff = `mtn --root=$config{mtnrootdir} au content_diff -r $oldrev -r $rev $file`; # was just $out;
59      
60                 if ($diff) {
61     @@ -314,8 +317,6 @@
62                                                 "Please use the non-web interface to resolve the conflicts.");
63                                 }
64                                 
65     -                           # suspend this revision because it has
66     -                           # conflict markers...
67                                 if (system("mtn", "--root=$config{mtnrootdir}",
68                                            "update", "-r", $mergeResult) != 0) {
69                                         debug("Unable to update to rev $mergeResult after conflict-enhanced merge on conflicted commit!");
70     @@ -363,7 +364,7 @@
71         check_config();
72      
73         if (system("mtn", "--root=$config{mtnrootdir}", "add", "--quiet",
74     -              "$config{srcdir}/$file") != 0) {
75     +              $file) != 0) {
76                 error("Monotone add failed");
77         }
78      } #}}}
79
80 >> BTW, will all the monotone output parsing work if LANG != C?
81
82 >>> It should (he says crossing fingers).
83 >>> In the places where I do any complex parsing I'm using a special
84 >>> version of the mtn commands designed for scripting.  They have a
85 >>> stable, easy to parse, output that doesn't get translated (I think).
86
87 >> Do monotone post-commit hooks actually use REV?
88
89 >>> Monotone post-commit hooks are written in Lua and can do
90 >>> what they please.  Setting the REV environment var before
91 >>> calling Ikiwiki seems reasonable, but I've not written the
92 >>> Lua hook.
93
94 >> --[[Joey]]