a0ee5ab60454632b2125afb525ac07aaa8882fc2
[ikiwiki.git] / doc / rcs / cvs.mdwn
1 [[!template id=gitbranch branch=schmonz/cvs author="[[schmonz]]"]]
2
3 If you really need to, you can use [[!wikipedia desc="CVS" Concurrent
4 Versions System]] with ikiwiki.
5
6 ### Usage
7 7. Install [[!cpan File::chdir]], [[!cpan File::ReadBackwards]],
8    [cvsps](http://www.cobite.com/cvsps/), and
9    [cvsweb](http://www.freebsd.org/projects/cvsweb.html) or the like.
10 7. Adjust CVS-related parameters in your setup file.
11
12 Consider creating `$HOME/.cvsrc` if you don't have one already; the
13 plugin doesn't need it, but you yourself might. Here's a good
14 general-purpose one:
15
16     cvs -q
17     checkout -P
18     update -dP
19     diff -u
20     rdiff -u
21
22 ### Implementation details
23 * [[ikiwiki-makerepo]]:
24     * creates a repository,
25     * imports `$SRCDIR` into top-level module `ikiwiki` (vendor tag
26       IKIWIKI, release tag PRE_CVS),
27     * configures the post-commit hook in `CVSROOT/loginfo`.
28
29 ### To do
30 * Expand test coverage and fix bugs.
31 * Have `ikiwiki-makerepo` set up NetBSD-like `log_accum` and
32   `commit_prep` scripts that coalesce commits into changesets. Reasons:
33     7. Obviates the need to scrape the repo's complete history to
34        determine the last N changesets. (Repositories without such
35        records can fall back on the `cvsps` and `File::ReadBackwards`
36        code.)
37     7. Arranges for ikiwiki to be run once per changeset, rather
38        than CVS's once per committed file (!), which is a waste at
39        best and bug-inducing at worst. (Currently, on multi-directory
40        commits, only the first directory's changes get mentioned
41        in [[recentchanges|plugins/recentchanges]].)
42 * Perhaps prevent web edits from attempting to create `.../CVS/foo.mdwn`
43   (and `.../cvs/foo.mdwn` on case-insensitive filesystems); thanks
44   to the CVS metadata directory, the attempt will fail anyway (and
45   much more confusingly) if we don't.