]> sipb.mit.edu Git - ikiwiki.git/commitdiff
add a table summarizing state of each rcs plugin
authorJoey Hess <joey@gnu.kitenet.net>
Mon, 29 Mar 2010 17:17:49 +0000 (13:17 -0400)
committerJoey Hess <joey@gnu.kitenet.net>
Mon, 29 Mar 2010 17:17:49 +0000 (13:17 -0400)
doc/rcs.mdwn
docwiki.setup

index f66b854954e57f85b221fc1d9df5504e2701e663..cd41e7f49eb597e703cbdfd20829c8a49928147f 100644 (file)
@@ -7,10 +7,27 @@ Ikiwiki started out supporting only [[Subversion|svn]], but the interface
 ikiwiki uses to a revision control system is sufficiently simple and
 generic that it can be adapted to work with many systems by writing a
 [[plugin|plugins/write]]. [[Subversion|svn]] is still a recommended choice;
-[[git]] is another well-tested option.
+[[git]] is another well-tested option. 
 
-These are all the supported revision control systems:
-[[!inline pages="rcs/* and !*/Discussion and !rcs/details" archive=yes]]
+While all supported revision control systems work well enough for basic use,
+some advanced or special features are not supported in all of them.
+Lack of support in [[ikiwiki-makerepo]] or auto.setup can make it harder to
+set up a wiki using that revision control system. The `rcs_commit_staged`
+hook is needed to use [[plugins/attachments]] or [[plugins/comments]]. And so
+on. The table below summarises this for each revision control system and links
+to more information about each.
+
+[[!table data="""
+feature             |[[git]]|[[svn]]|[[bzr]]   |[[monotone]]|[[mercurial]]|[[darcs]]|[[tla]]   |[[cvs]]
+[[ikiwiki-makerepo]]|yes    |yes    |yes       |yes         |yes          |yes      |no        |yes
+auto.setup          |yes    |yes    |incomplete|yes         |incomplete   |yes      |incomplete|yes
+`rcs_commit_staged` |yes    |yes    |yes       |yes         |no           |yes      |no        |yes
+`rcs_rename`        |yes    |yes    |yes       |yes         |no           |yes      |no        |yes
+`rcs_remove`        |yes    |yes    |yes       |yes         |no           |yes      |no        |yes
+`rcs_diff`          |yes    |yes    |yes       |yes         |no           |yes      |yes       |yes
+anonymous push      |yes    |no     |no        |no          |no           |no       |no        |no
+conflict handling   |yes    |yes    |yes       |buggy       |yes          |yes      |yes       |yes
+"""]]
 
 There is a page with [[details]] about how the different systems work with
 ikiwiki, for the curious.
index 86f012c50ac281fb1506c4392bb316d49d673900..8278b73ea5c95ea44b16a690a996a9286db20fe2 100644 (file)
@@ -16,5 +16,5 @@ use IkiWiki::Setup::Standard {
        userdir => "users",
        usedirs => 0,
        prefix_directives => 1,
-       add_plugins => [qw{goodstuff version haiku polygen fortune}],
+       add_plugins => [qw{goodstuff version haiku polygen fortune table}],
 }