./textproc/igor, FreeBSD Project documentation sanity checker

[ CVSweb ] [ Homepage ] [ RSS ] [ Required by ] [ Add to tracker ]


Branch: pkgsrc-2016Q4, Version: 0.0.20140517nb2, Package name: igor-0.0.20140517nb2, Maintainer: pkgsrc-users

The many rules for man pages and DocBook are a bit much to remember when
months can pass between working on the various types.

After not finding much to do automated checking, I slapped together a
Perl program called "igor" that does some of this. At present it checks
all types of files for repeated words ("is is"), common spelling
mistakes collected from FreeBSD documents, FreeBSD obsolete features
(just "cvsup" so far), bad phrases ("the to"), and bad whitespace (blank
lines with whitespace or lines with trailing whitespace).
There's a separate style check that makes some subjective suggestions.

There are also particular tests for mdoc(7) and DocBook files.


Required to run:
[lang/perl5]

Required to build:
[pkgtools/cwrappers]

Master sites:


Version history: (Expand)