note Perl module dependencies
authorhttp://schmonz.livejournal.com/ <http://schmonz.livejournal.com/@web>
Mon, 3 Aug 2009 06:56:42 +0000 (02:56 -0400)
committerJoey Hess <joey@kitenet.net>
Mon, 3 Aug 2009 06:56:42 +0000 (02:56 -0400)
doc/plugins/contrib/cvs.mdwn

index 1ff71d274bc4a68ed15a8dafd6e479ee43a56f16..727c3524a05a057ab3ecca575b2c22f1de6f0fef 100644 (file)
@@ -10,6 +10,7 @@ This plugin allows ikiwiki to use [[!wikipedia desc="CVS" Concurrent Versions Sy
  * 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`](http://www.cobite.com/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`.
 * No testing or special-casing has been done with [[attachments|plugins/attachment]], but they'll probably need `cvs add -kb`.