Mercurial > masqmail

annotate misc/are-options-documented @ 156:ee2afbf92428

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
require host_name to be set in config file exit otherwise there is no portable way to determine the hostname (actually the hostname that masqmail should use) thus it must be set by the administrator
author meillo@marmaro.de
date Thu, 08 Jul 2010 09:49:05 +0200
parents 867bb186a829
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
140
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
1 #!/bin/sh
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
2 #
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
3 # checks if all recognized options are documented
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
4 # run from masqmail's repository root dir
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
5 #
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
6 # Note: this script is far from perfect, but its development time to
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
7 # usage value ratio is quite good :-)
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
8
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
9 docs="/tmp/masqmail-opts-docs.$$"
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
10 code="/tmp/masqmail-opts-code.$$"
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
11
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
12 cat man/masqmail.*.5 | grep -o '^\\fB[^(\\]*\\f.' |
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
13 egrep -v 'OBSOLETE|http://' | sed 's,^\\fB,,; s,[\\ =].*,,' |
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
14 sort -u | grep -v '^val$' >"$docs"
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
15
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
16 cat src/conf.c | grep 'lval,.*"' |
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
17 sed 's,[^"]*",,; s,"\, [0-9]*,",; s,".*,,' | sort -u >"$code"
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
18
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
19 diff -U 0 "$code" "$docs" | grep -v '^@@'
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
20
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
21 rm -f "$docs" "$code"