masqmail-0.2
view misc/are-options-documented @ 140:867bb186a829
added a script that checks the documentation coverage of config options
| author | meillo@marmaro.de |
|---|---|
| date | Tue, 06 Jul 2010 17:43:31 +0200 |
| parents | |
| children |
line source
1 #!/bin/sh
2 #
3 # checks if all recognized options are documented
4 # run from masqmail's repository root dir
5 #
6 # Note: this script is far from perfect, but its development time to
7 # usage value ratio is quite good :-)
9 docs="/tmp/masqmail-opts-docs.$$"
10 code="/tmp/masqmail-opts-code.$$"
12 cat man/masqmail.*.5 | grep -o '^\\fB[^(\\]*\\f.' |
13 egrep -v 'OBSOLETE|http://' | sed 's,^\\fB,,; s,[\\ =].*,,' |
14 sort -u | grep -v '^val$' >"$docs"
16 cat src/conf.c | grep 'lval,.*"' |
17 sed 's,[^"]*",,; s,"\, [0-9]*,",; s,".*,,' | sort -u >"$code"
19 diff -U 0 "$code" "$docs" | grep -v '^@@'
21 rm -f "$docs" "$code"