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

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

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

  • Diffs are against [[3.14159|news/version_3.14159]]. cvs.pm started life as a copy of 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,
  • configures the wrapper itself as a post-commit hook in CVSROOT/loginfo.
  • cvsps is required (rcs_recentchanges() and rcs_diff() need it to work).
  • [[!cpan IPC::Cmd]] and [[!cpan String::ShellQuote]] are required (to safely keep cvs quiet and to safely escape commit messages, respectively).
  • 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 might be possible to solve this problem with scripts like commit_prep and log_accum from CVS contrib.
  • Due to the name of CVS's metadata directories, it's impossible to create .../CVS/foo.mdwn. On case-insensitive filesystems it's also impossible to create .../cvs/foo.mdwn. Since the failure can have confusing effects on one's CVS checkout, perhaps the web interface should prevent the attempt.
  • No testing or special-casing has been done with [[attachments|plugins/attachment]], but they'll probably need cvs add -kb.

Having a $HOME/.cvsrc isn't necessary. Sure does make using CVS more livable, though. Here's a good general-purpose one:

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

Not knowing how the tests get set up, I blindly attempted to add subversion-like tests to t/file_pruned.t. They fail. But the plugin definitely works. :-)

Code