Mercurial > masqmail

annotate devel/are-options-documented @ 434:f2a7271746d1 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Removes Freshmeat.net from the docs The site, which was later renamed to freecode.com, is no longer maintained (contains only a static copy).
author markus schnalke <meillo@marmaro.de>
date Sat, 07 Feb 2015 11:45:07 +0100
parents 4905a1d9e6a7
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
352
4905a1d9e6a7 minor improvement of output of devel/are-options-documented
markus schnalke <meillo@marmaro.de>
parents: 226
diff changeset
19 diff -U 0 "$code" "$docs" | grep -v '^@@' |
4905a1d9e6a7 minor improvement of output of devel/are-options-documented
markus schnalke <meillo@marmaro.de>
parents: 226
diff changeset
20 sed 's/^---.*/--- code/;s/^+++.*/+++ docs/'
140
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
21
867bb186a829 added a script that checks the documentation coverage of config options
meillo@marmaro.de
parents:
diff changeset
22 rm -f "$docs" "$code"