diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/about_rcs_backends.mdwn | 11 | ||||
| -rw-r--r-- | doc/features.mdwn | 3 | ||||
| -rw-r--r-- | doc/plugins/write.mdwn | 2 |
3 files changed, 9 insertions, 7 deletions
diff --git a/doc/about_rcs_backends.mdwn b/doc/about_rcs_backends.mdwn index 4aba78fc0..ea7a9ac89 100644 --- a/doc/about_rcs_backends.mdwn +++ b/doc/about_rcs_backends.mdwn @@ -22,6 +22,9 @@ HTML is generated from W. rcs_update() will update from M to W. CGI operates on W. rcs_commit() will commit from W to M. +For all the gory details of how ikiwiki handles this behind the scenes, +see [[commit-internals]]. + You browse and web-edit the wiki on W. @@ -45,11 +48,11 @@ There is a working copy of R1: R2. CGI operates on R2. rcs_commit() will push from R2 to R1. You browse the wiki on R1 and web-edit it on R2. This means for example -that R2 needs to be updated from R1 if you are going the web-edit a page, +that R2 needs to be updated from R1 if you are going to web-edit a page, as the user otherwise might be irritated otherwise... How do changes get from R1 to R2? Currently only internally in -rcs_commit(). Is rcs_prepedit() suitable? +rcs\_commit(). Is rcs\_prepedit() suitable? It follows that the HTML rendering and the CGI handling can be completely separated parts in ikiwiki. @@ -62,11 +65,11 @@ darcs is a distributed RCS, which means that every checkout of a repository is equal to the repository it was checked-out from. There is no forced hierarchy. -R1 is the nevertheless called the master repository. It's used for +R1 is nevertheless called the master repository. It's used for collecting all the changes and publishing them: on the one hand via the rendered HTML and on the other via the standard darcs RCS interface. -R2, the repository where CGI operates on, is just a checkout of R1 and +R2, the repository the CGI operates on, is just a checkout of R1 and doesn't really differ from the other checkouts that people will branch off from R1. diff --git a/doc/features.mdwn b/doc/features.mdwn index 5765552f0..b58392fd5 100644 --- a/doc/features.mdwn +++ b/doc/features.mdwn @@ -97,9 +97,6 @@ Some of ikiwiki's features: shown in the file to resolve the conflict, so if you're already familiar with that there's no new commit marker syntax to learn. - For all the gory details of how ikiwiki handles this behind the scenes, - see [[commit-internals]]. - * page locking Wiki admins can lock pages so that only other admins can edit them. diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index d881554ca..969862842 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -147,3 +147,5 @@ modules. These are in the `IkiWiki::RCS` namespace, for example Each RCS plugin must support all the IkiWiki::rcs\_* functions. See IkiWiki::RCS::Stub for the full list of functions. It's ok if rcs\_getctime does nothing except for throwing an error. + +See [[about_RCS_backends]] for some more info. |