aboutsummaryrefslogtreecommitdiff
path: root/doc/check-docs.sh
blob: 709b1d6ba123539fdcc75cc5f1213aa078fb3b75 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
#! /bin/sh
# This file is part of mailfrom filter.
# Copyright (C) 2006, 2007, 2010 Sergey Poznyakoff
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

usage() {
  cat <<EOT
usage: $0 item code-sed doc-sed sources -- args...
EOT
}

if [ $# -le 4 ]; then
  usage
  exit 2
fi

item=$1
shift
codesexp="$1"
shift
docsexp=$1
shift

source=
while [ $# -ne 0 ]
do
	if [ "$1" = "--" ]; then
		shift
		break;
	fi
	source="$source $1"
	shift
done	

TEMPDIR=/tmp/mfck.$$
mkdir $TEMPDIR || exit 1
trap 'rm -rf $TEMPDIR' 1 2 13 15

sed -n "$codesexp" $source | sort | uniq > $TEMPDIR/src
$* | \
 sed -n '/^@macro/,/^@end macro/d;'"$docsexp" \
  | sort | uniq > $TEMPDIR/doc

join -v1 $TEMPDIR/src $TEMPDIR/doc > $TEMPDIR/src-doc
join -v2 $TEMPDIR/src $TEMPDIR/doc > $TEMPDIR/doc-src
(if [ -s $TEMPDIR/src-doc ]; then
   echo "Not documented $item:"
   cat $TEMPDIR/src-doc 
 fi
 if [ -s $TEMPDIR/doc-src ]; then
   echo "Non-existing $item:"
   cat $TEMPDIR/doc-src
 fi) > $TEMPDIR/report

if [ -s $TEMPDIR/report ]; then 
  cat $TEMPDIR/report
  rm -rf $TEMPDIR
  exit 1
else
  rm -rf $TEMPDIR
  exit 0
fi

Return to:

Send suggestions and report system problems to the System administrator.