doc/rcs.mdwn

   1 [[!meta title="Revision Control Systems"]]
   2
   3 Ikiwiki supports using several revision control systems for storing page
   4 histories.
   5
   6 Ikiwiki started out supporting only [[Subversion|svn]], but the interface
   7 ikiwiki uses to a revision control system is sufficiently simple and
   8 generic that it can be adapted to work with many systems by writing a
   9 [[plugin|plugins/write]]. These days, most people use [[git]].
  10
  11 While all supported revision control systems work well enough for basic
  12 use, some advanced or special features are not supported in all of them.
  13 Lack of support in [[ikiwiki-makerepo]] or auto.setup can make it harder to
  14 set up a wiki using that revision control system. The `rcs_commit_staged`
  15 hook is needed to use [[attachments|plugins/attachment]] or
  16 [[plugins/comments]]. `rcs_getctime` may be implemented in a fast way
  17 (ie, one log lookup for all files), or very slowly (one lookup per file).
  18 And so on. The table below summarises this for each revision control
  19 system and links to more information about each.
  20
  21 [[!table data="""
  22 feature             |[[git]]|[[svn]]|[[bzr]]   |[[monotone]]|[[mercurial]]|[[darcs]]|[[tla]]   |[[cvs]]
  23 [[ikiwiki-makerepo]]|yes    |yes    |yes       |yes         |yes          |yes      |no        |yes
  24 auto.setup          |yes    |yes    |incomplete|yes         |incomplete   |yes      |incomplete|yes
  25 `rcs_commit_staged` |yes    |yes    |yes       |yes         |no           |yes      |no        |yes
  26 `rcs_rename`        |yes    |yes    |yes       |yes         |no           |yes      |no        |yes
  27 `rcs_remove`        |yes    |yes    |yes       |yes         |no           |yes      |no        |yes
  28 `rcs_diff`          |yes    |yes    |yes       |yes         |no           |yes      |yes       |yes
  29 `rcs_getctime`      |fast   |slow   |slow      |slow        |slow         |slow     |slow      |slow
  30 `rcs_getmtime`      |fast   |slow   |slow      |no          |no           |no       |no        |no
  31 anonymous push      |yes    |no     |no        |no          |no           |no       |no        |no
  32 conflict handling   |yes    |yes    |yes       |buggy       |yes          |yes      |yes       |yes
  33 """]]
  34
  35 There is a page with [[details]] about how the different systems work with
  36 ikiwiki, for the curious.