doc/plugins/contrib/cvs.mdwn

   1 [[!template id=plugin name=cvs core=0 author="[[schmonz]]"]]
   2
   3 [[!template id=gitbranch branch=schmonz author="[[schmonz]]"]]
   4
   5 This plugin allows ikiwiki to use [[!wikipedia desc="CVS" Concurrent Versions System]] as an [[rcs]].
   6
   7 ### Usage
   8 7. Install [cvsps](http://www.cobite.com/cvsps/), [[!cpan IPC::Cmd]], [[!cpan String::ShellQuote]], and [cvsweb](http://www.freebsd.org/projects/cvsweb.html) or the like.
   9 7. Adjust CVS-related parameters in your setup file.
  10
  11 Consider creating `$HOME/.cvsrc` if you don't have one already; the plugin doesn't need it, but you yourself might. Here's a good general-purpose one:
  12
  13     cvs -q
  14     checkout -P
  15     update -dP
  16     diff -u
  17     rdiff -u
  18
  19 ### Implementation details
  20 * `cvs.pm` started life as a copy of [[3.14159|news/version_3.14159]]'s `svn.pm`.
  21 * `IkiWiki.pm:wiki_file_prune_regexps` avoids copying CVS metadata into `$DESTDIR`.
  22 * [[ikiwiki-makerepo]]:
  23  * creates a repository,
  24  * imports `$SRCDIR` into top-level module `ikiwiki` (vendor tag IKIWIKI, release tag PRE_CVS),
  25  * configures the post-commit hook in `CVSROOT/loginfo`.
  26 * CVS multi-directory commits happen separately; the post-commit hook sees only the first directory's changes in time for [[recentchanges|plugins/recentchanges]]. The next run of `ikiwiki --setup` will correctly re-render such a recentchanges entry. It should be possible to solve this problem with NetBSD's `commit_prep` and `log_accum` scripts (see below).
  27
  28 ### To do
  29 * Add automated tests. (Blindly adding svn-like tests to `t/file_pruned.t` doesn't do the trick.)
  30 * If the argument to `cvs add` smells like a binary file, `cvs add -kb` it (for [[plugins/attachment]] support).
  31 * Don't slurp the entire `cvsps` output into memory (!).
  32 * Instead of resource-intensively scraping changesets with `cvsps`, have `ikiwiki-makerepo` set up NetBSD-like `log_accum` and `commit_prep` scripts that coalesce and keep records of commits. `cvsps` can be used as a fallback for repositories without such records.
  33 * Perhaps prevent web edits from attempting to create `.../CVS/foo.mdwn` (and `.../cvs/foo.mdwn` on case-insensitive filesystems); thanks to the CVS metadata directory, the attempt will fail anyway (and much more confusingly) if we don't.