apply monotone patch
[ikiwiki.git] / doc / bugs / Monotone_rcs_support.mdwn
index 95f75975366615c9066774d73a2acfe42149854a..d1ef00246cd7a97410da9886f33584baa484aa0e 100644 (file)
@@ -1,50 +1,70 @@
 #Ikiwiki plugin for the Monotone revision control system.
 
-I've just made a patch to the ikiwiki code that allows it to use the [Monotone](http://monotone.ca/) revision control system.  It is available at:
+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:
 
 <http://www.cse.unsw.edu.au/~willu/monotone-ikiwiki.diff>
 
 At the moment it is basically complete.  At present rcs_notify() is implemeted but untested, the rest is implemented and tested.
 
-In an older version of the patch 
-there was support for simultaneous commits, but any conflicts left the repository in an unmerged state which had to be cleaned up using the non-web
-monotone interface.  The user's data was still stored, and the user was informed if that happened.
-
 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.
 
-Note: This patch requires the Monotone perl module, which is only available in Monotone 0.36 or later.  The module is in the Monotone contrib/ directory.  While 0.36 is relatively new, that Monotone module itself will work with a monotone binary back quite a few releases.
-Apparently this module did't make some versions of the monotone 0.36 release tarball.  It is available from the monotone repository here: <http://viewmtn.angrygoats.net/branch/changes/net.venge.monotone>.
+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>.
 
 > The setup instructions to add 40 lines of code to monotonerc is pretty frightning stuff.
 > Is there some way this can be automated? --[[Joey]]
 
->> I've committed a bunch of this to monotone so that in future it could be removed.  I didn't
->> want to remove it from the instructions until it was in a monotone release though.
-
->>> Fair enough. Didn't realize you were a monotone committer. :-) As long as it goes away later I don't mind having it in setup initially.
+>> I've committed a bunch of this to monotone so that in future it could be removed.
+>> I've also just fixed this so it is in a separate, automagically generated, rc file.
 
->> The real issue here is that there is a mismatch between ikiwiki's conflict model and
->> monotone's.  I need to get code into monotone to add conflict markers - that is
->> the code that goes in the monotonerc.  In practice I could add this to any file I know
->> how to reference and I can then tell monotone about it with a command line arg.
->> Is there a good place for such a file?
+>>> Fair enough. Didn't realize you were a monotone committer. :-)
 
->>> There's not a really good place. /usr/share/ikiwiki/foo would do, 
->>> except for the systems where /usr/share/ is elsewhere. It would need to be
->>> runtime configurable just like the basewiki and template locations are.
->>> 
->>> Hmm, another option would be to put it in the wiki's .ikiwiki directory when
->>> ikiwiki starts up. This is the technique used by the search plugin to create
->>> various data and config files that hyperestradier needs.
+>>>> I am, but still a little newish.  Feedback is good.  In particular, this is my first major bit of PERL.
 
 > Having rcs_commit return a warning message when there's an unresolved conflict
 > isn't right; that message will populate the page edit box. You might want
 > to use the error() function here?
 
->> It should never reach that case, so yes, I can change that to error.
+>> It should never reach that case, so I have changed that to error.
 
 > There'an incomplete comment ending with "note, this relies on the fact that"
 
->> erg... sorry, will fix.
+>> erg... sorry, fixed.
 
 [[tag patch]]
+
+>> I've [[accepted|done]] this patch, thank you! 
+
+>>> Thanks for committing it.  I hate keeping my own diffs. :)
+
+>> I did make a few changes. Please review, and make sure it still works
+>> (a test case like we have for some of the other RCSes would be nice..)
+
+>>> Tested.  It still works at least as well as it did.  I'll try to get to a test case soon.
+>>> In checking the source I noticed a few bogus comments I left in when editing,
+>>> and a bug in page adding.
+>>> Here is a small patch for them:
+
+>>>> applied
+
+Here is another patch.  It fixes a FIXME you added.  I was using $file within backticks because
+I was getting an error trying to do it right.  I've figured out the error, and now do it right.  This
+should also speed things up (very slightly)
+
+> applied
+
+>> BTW, will all the monotone output parsing work if LANG != C?
+
+>>> It should (he says crossing fingers).
+>>> In the places where I do any complex parsing I'm using a special
+>>> version of the mtn commands designed for scripting.  They have a
+>>> stable, easy to parse, output that doesn't get translated (I think).
+
+>> Do monotone post-commit hooks actually use REV?
+
+>>> Monotone post-commit hooks are written in Lua and can do
+>>> what they please.  Setting the REV environment var before
+>>> calling Ikiwiki seems reasonable, but I've not written the
+>>> Lua hook.
+
+>>>> So the rcs_notify support is not just untested, but can't work
+>>>> at all w/o further development.