X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/70ce716007e2fdeabc3350a10ec08ff34c0246be..dd0981824d1d919f431d75af47e07447d460e1b4:/doc/about_rcs_backends.mdwn diff --git a/doc/about_rcs_backends.mdwn b/doc/about_rcs_backends.mdwn index 0a95b7f54..c20fa5cc3 100644 --- a/doc/about_rcs_backends.mdwn +++ b/doc/about_rcs_backends.mdwn @@ -29,11 +29,14 @@ see [[commit-internals]]. You browse and web-edit the wiki on W. +W "belongs" to ikiwiki and should not be edited directly. + ## [darcs](http://darcs.net/) (not yet included) Support for using darcs as a backend is being worked on by [Thomas -Schwinge](mailto:tschwinge@gnu.org). +Schwinge](mailto:tschwinge@gnu.org), although development is on hold curretly. +There is a patch in the [[patchqueue]]. ### How will it work internally? @@ -102,6 +105,18 @@ by Ikiwiki. This approach might be applicable to other distributed VCSs as well, although they're not as oriented towards transmitting changes with standalone patch bundles (often by email) as darcs is. +> The mercurial plugin seems to just use one repo and edit it directly - is +> there some reason that's okay there but not for darcs? I agree with tuomov +> that having just the one repo would be preferable; the point of a dvcs is +> that there's no difference between one repo and another. I've got a +> darcs.pm based on mercurial.pm, that's almost usable... --bma + +>> IMHO it comes down to whatever works well for a given RCS. Seems like +>> the darcs approach _could_ be done with most any distributed system, but +>> it might be overkill for some (or all?) While there is the incomplete darcs +>> plugin in the [[patchqueue]], if you submit one that's complete, I will +>> probably accept it into ikiwiki.. --[[Joey]] + ## [[Git]] Regarding the Git support, Recai says: @@ -117,8 +132,48 @@ part). GIT doesn't have a similar functionality like 'svn merge -rOLD:NEW FILE' (please see the relevant comment in mergepast for more details), so I had to invent an ugly hack just for the purpose. -## [mercurial](http://www.selenic.com/mercurial/) +By design, Git backend uses a "master-clone" repository pair approach in contrast +to the single repository approach (here, _clone_ may be considered as the working +copy of a fictious web user). Even though a single repository implementation is +possible, it somewhat increases the code complexity of backend (I couldn't figure +out a uniform method which doesn't depend on the prefered repository model, yet). +By exploiting the fact that the master repo and _web user_'s repo (`srcdir`) are all +on the same local machine, I suggest to create the latter with the "`git clone -l -s`" +command to save disk space. + +Note that, as a rule of thumb, you should always put the rcs wrapper (`post-update`) +into the master repository (`.git/hooks/`) as can be noticed in the Git wrappers of +the sample [[ikiwiki.setup]]. + +## [[Mercurial]] + +The Mercurial backend is still in a early phase, so it may not be mature +enough, but it should be simple to understand and use. + +As Mercurial is a distributed RCS, it lacks the distinction between +repository and working copy (every wc is a repo). + +This means that the Mercurial backend uses directly the repository as +working copy (the master M and the working copy W described in the svn +example are the same thing). + +You only need to specify 'srcdir' (the repository M) and 'destdir' (where +the HTML will be generated). + +Master repository M. + +RCS commit from the outside are installed into M. + +M is directly used as working copy (M is also W). + +HTML is generated from the working copy in M. rcs_update() will update +to the last committed revision in M (the same as 'hg update'). +If you use an 'update' hook you can generate automatically the HTML +in the destination directory each time 'hg update' is called. + +CGI operates on M. rcs_commit() will commit directly in M. -Being worked on by Emanuele Aina. +If you have any question or suggestion about the Mercurial backend +please refer to [Emanuele](http://nerd.ocracy.org/em/) - +## [[tla]]