thanks James!
[ikiwiki.git] / doc / about_rcs_backends.mdwn
1 A few bits about the RCS backends
2
3 [[toc ]]
4
5 ## Terminology
6
7 ``web-edit'' means that a page is edited by using the web (CGI) interface
8 as opposed to using a editor and the RCS interface.
9
10
11 ## [[Subversion]]
12
13 Subversion was the first RCS to be supported by ikiwiki.
14
15 ### How does it work internally?
16
17 Master repository M.
18
19 RCS commits from the outside are installed into M.
20
21 There is a working copy of M (a checkout of M): W.
22
23 HTML is generated from W.  rcs_update() will update from M to W.
24
25 CGI operates on W.  rcs_commit() will commit from W to M.
26
27 For all the gory details of how ikiwiki handles this behind the scenes,
28 see [[commit-internals]].
29
30 You browse and web-edit the wiki on W.
31
32
33 ## [darcs](http://darcs.net/) (not yet included)
34
35 Support for using darcs as a backend is being worked on by [Thomas
36 Schwinge](mailto:tschwinge@gnu.org), although development is on hold curretly.
37 There is a patch in the [[patchqueue]].
38
39 ### How will it work internally?
40
41 ``Master'' repository R1.
42
43 RCS commits from the outside are installed into R1.
44
45 HTML is generated from R1.  HTML is automatically generated (by using a
46 ``post-hook'') each time a new change is installed into R1.  It follows
47 that rcs_update() is not needed.
48
49 There is a working copy of R1: R2.
50
51 CGI operates on R2.  rcs_commit() will push from R2 to R1.
52
53 You browse the wiki on R1 and web-edit it on R2.  This means for example
54 that R2 needs to be updated from R1 if you are going to web-edit a page,
55 as the user otherwise might be irritated otherwise...
56
57 How do changes get from R1 to R2?  Currently only internally in
58 rcs\_commit().  Is rcs\_prepedit() suitable?
59
60 It follows that the HTML rendering and the CGI handling can be completely
61 separated parts in ikiwiki.
62
63 What repository should [[RecentChanges]] and [[History]] work on?  R1?
64
65 #### Rationale for doing it differently than in the Subversion case
66
67 darcs is a distributed RCS, which means that every checkout of a
68 repository is equal to the repository it was checked-out from.  There is
69 no forced hierarchy.
70
71 R1 is nevertheless called the master repository.  It's used for
72 collecting all the changes and publishing them: on the one hand via the
73 rendered HTML and on the other via the standard darcs RCS interface.
74
75 R2, the repository the CGI operates on, is just a checkout of R1 and
76 doesn't really differ from the other checkouts that people will branch
77 off from R1.
78
79 (To be continued.)
80
81 #### Another possible approach
82
83 Here's what I (tuomov) think, would be a “cleaner” approach:
84
85  1. Upon starting to edit, Ikiwiki gets a copy of the page, and `darcs changes --context`.
86      This context _and_ the present version of the page are stored in as the “version” of the
87      page in a hidden control of the HTML.
88      Thus the HTML includes all that is needed to generate a patch wrt. to the state of the
89      repository at the time the edit was started. This is of course all that darcs needs.
90  2. Once the user is done with editing, _Ikiwiki generates a patch bundle_ for darcs.
91      This should be easy with existing `Text::Diff` or somesuch modules, as the Web edits
92      only concern single files. The reason why the old version of the page is stored in
93      the HTML (possibly compressed) is that the diff can be generated.
94  3. Now this patch bundle is applied with `darcs apply`, or sent by email for moderation…
95      there are many possibilities.
96
97 This approach avoids some of the problems of concurrent edits that the previous one may have,
98 although there may be conflicts, which may or may not propagate to the displayed web page.
99 (Unfortunately there is not an option to `darcs apply` to generate some sort of ‘confliction resolution
100 bundle’.) Also, only one repository is needed, as it is never directly modified
101 by Ikiwiki. 
102
103 This approach might be applicable to other distributed VCSs as well, although they're not as oriented
104 towards transmitting changes with standalone patch bundles (often by email) as darcs is.
105
106 ## [[Git]]
107
108 Regarding the Git support, Recai says:
109
110 I have been testing it for the past few days and it seems satisfactory.  I
111 haven't observed any race condition regarding the concurrent blog commits
112 and it handles merge conflicts gracefully as far as I can see.
113
114 As you may notice from the patch size, GIT support is not so trivial to
115 implement (for me, at least).  Being a fairly fresh code base it has some
116 bugs.  It also has some drawbacks (especially wrt merge which was the hard
117 part).  GIT doesn't have a similar functionality like 'svn merge -rOLD:NEW
118 FILE' (please see the relevant comment in mergepast for more details), so I
119 had to invent an ugly hack just for the purpose.
120
121 By design, Git backend uses a "master-clone" repository pair approach in contrast
122 to the single repository approach (here, _clone_ may be considered as the working
123 copy of a fictious web user).  Even though a single repository implementation is
124 possible, it somewhat increases the code complexity of backend (I couldn't figure
125 out a uniform method which doesn't depend on the prefered repository model, yet).
126 By exploiting the fact that the master repo and _web user_'s repo (`srcdir`) are all
127 on the same local machine, I suggest to create the latter with the "`git clone -l -s`"
128 command to save disk space.
129
130 Note that, as a rule of thumb, you should always put the rcs wrapper (`post-update`)
131 into the master repository (`.git/hooks/`) as can be noticed in the Git wrappers of
132 the sample [[ikiwiki.setup]].
133
134 ## [[Mercurial]]
135
136 The Mercurial backend is still in a early phase, so it may not be mature 
137 enough, but it should be simple to understand and use.
138
139 As Mercurial is a distributed RCS, it lacks the distinction between 
140 repository and working copy (every wc is a repo).
141
142 This means that the Mercurial backend uses directly the repository as 
143 working copy (the master M and the working copy W described in the svn 
144 example are the same thing).
145
146 You only need to specify 'srcdir' (the repository M) and 'destdir' (where
147 the HTML will be generated).
148
149 Master repository M.
150
151 RCS commit from the outside are installed into M.
152
153 M is directly used as working copy (M is also W).
154
155 HTML is generated from the working copy in M. rcs_update() will update 
156 to the last committed revision in M (the same as 'hg update').
157 If you use an 'update' hook you can generate automatically the HTML
158 in the destination directory each time 'hg update' is called.
159
160 CGI operates on M. rcs_commit() will commit directly in M.
161
162 If you have any question or suggestion about the Mercurial backend 
163 please refer to [Emanuele](http://nerd.ocracy.org/em/)
164
165 ## [[tla]]