summaryrefslogtreecommitdiff
path: root/doc/plugins/contrib/cvs.mdwn
blob: 23e00201fa08b8997975d7ce0b735c9741f0eb7c (plain)

[[!template id=plugin name=cvs core=0 author="[[schmonz]]"]]

[[!template id=gitbranch branch=schmonz author="[[schmonz]]"]]

This plugin allows ikiwiki to use [[!wikipedia desc="CVS" Concurrent Versions System]] as an [[rcs]].

Usage

  1. Install cvsps, [[!cpan IPC::Cmd]], [[!cpan String::ShellQuote]], and cvsweb or the like.
  2. Adjust CVS-related parameters in your setup file.

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:

cvs -q
checkout -P
update -dP
diff -u
rdiff -u

Implementation details

  • cvs.pm started life as a copy of [[3.14159|news/version_3.14159]]'s svn.pm.
  • IkiWiki.pm:wiki_file_prune_regexps avoids copying CVS metadata into $DESTDIR.
  • [[ikiwiki-makerepo]]:
  • creates a repository,
  • imports $SRCDIR into top-level module ikiwiki (vendor tag IKIWIKI, release tag PRE_CVS),
  • creates a small post-commit wrapper to prevent cvs add <directory> from being seen by ikiwiki's [[post-commit]] hook (and avoid cvs locking against itself),
  • configures the wrapper itself as a post-commit hook in CVSROOT/loginfo.
  • 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).

To do

  • Add automated tests. (Blindly adding svn-like tests to t/file_pruned.t doesn't do the trick.)
  • If the argument to cvs add smells like a binary file, cvs add -kb it (for [[plugins/attachment]] support).
  • Don't slurp the entire cvsps output into memory (!).
  • 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.
  • 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.