]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins/contrib/cvs.mdwn
Merge branch 'master' into cvs
[ikiwiki.git] / 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 [[!cpan File::chdir]], [[!cpan File::ReadBackwards]],
9 [cvsps](http://www.cobite.com/cvsps/), and
10 [cvsweb](http://www.freebsd.org/projects/cvsweb.html) or the like.
11 7. Adjust CVS-related parameters in your setup file.
12
13 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:
14
15     cvs -q
16     checkout -P
17     update -dP
18     diff -u
19     rdiff -u
20
21 ### Implementation details
22 * `cvs.pm` started life as a copy of [[3.14159|news/version_3.14159]]'s `svn.pm`.
23 * `IkiWiki.pm:wiki_file_prune_regexps` avoids copying CVS metadata
24 into `$DESTDIR`.
25 * `IkiWiki/Wrapper.pm` provides a new "wrapperargcheck" hook, which
26 the plugin implements to avoid calling ikiwiki from post-commit
27 (and locking against itself) if it's a directory being `cvs add`ed.
28 * [[ikiwiki-makerepo]]:
29  * creates a repository,
30  * imports `$SRCDIR` into top-level module `ikiwiki` (vendor tag IKIWIKI, release tag PRE_CVS),
31  * configures the post-commit hook in `CVSROOT/loginfo`.
32 * 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).
33
34 ### To do
35 * 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.
36 * 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.