Mercurial > masqmail-0.2
changeset 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 (2010-07-06) |
parents | 4d32eb75d3bc |
children | fc731510cc9d |
files | misc/are-options-documented |
diffstat | 1 files changed, 21 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/misc/are-options-documented Tue Jul 06 17:43:31 2010 +0200 @@ -0,0 +1,21 @@ +#!/bin/sh +# +# checks if all recognized options are documented +# run from masqmail's repository root dir +# +# Note: this script is far from perfect, but its development time to +# usage value ratio is quite good :-) + +docs="/tmp/masqmail-opts-docs.$$" +code="/tmp/masqmail-opts-code.$$" + +cat man/masqmail.*.5 | grep -o '^\\fB[^(\\]*\\f.' | + egrep -v 'OBSOLETE|http://' | sed 's,^\\fB,,; s,[\\ =].*,,' | + sort -u | grep -v '^val$' >"$docs" + +cat src/conf.c | grep 'lval,.*"' | + sed 's,[^"]*",,; s,"\, [0-9]*,",; s,".*,,' | sort -u >"$code" + +diff -U 0 "$code" "$docs" | grep -v '^@@' + +rm -f "$docs" "$code"