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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
#!@PERL@ -w
# -*- cperl -*-
#
# gtk-doc - GTK DocBook documentation generator.
# Copyright (C) 2007 David Nečas
#
# 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 2 of the License, 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, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
#############################################################################
# Script : gtkdoc-check
# Description : Runs various checks on built documentation and outputs test
# results. Can be run druring make check, by adding this to the
# documentations Makefile.am: TESTS = $(GTKDOC_CHECK)
#############################################################################
use strict;
use Getopt::Long;
my $PRINT_VERSION;
my $PRINT_HELP;
my %optctl = ('version' => \$PRINT_VERSION,
'help' => \$PRINT_HELP);
GetOptions(\%optctl, "version", "help");
if ($PRINT_VERSION) {
print "@VERSION@\n";
exit 0;
}
if ($PRINT_HELP) {
print <<EOF;
gtkdoc-check version @VERSION@ - run documentation unit tests
--version Print the version of this program
--help Print this help
EOF
exit 0;
}
my $DOC_MODULE;
my $checks = 3;
# We like Makefile.am more but builddir does not necessarily contain one.
my $makefile = (-f 'Makefile.am') ? 'Makefile.am' : 'Makefile';
$DOC_MODULE = &Grep('^\s*DOC_MODULE\s*=\s*(\S+)', $makefile, 'DOC_MODULE');
print "Running suite(s): gtk-doc-$DOC_MODULE\n";
my $undocumented = int &Grep('^(\d+)\s+not\s+documented\.\s*$',
"$DOC_MODULE-undocumented.txt",
'number of undocumented symbols');
my $incomplete = int &Grep('^(\d+)\s+symbols?\s+incomplete\.\s*$',
"$DOC_MODULE-undocumented.txt",
'number of incomplete symbols');
my $total = $undocumented + $incomplete;
if ($total) {
print "$DOC_MODULE-undocumented.txt:1:E: $total undocumented or incomplete symbols\n";
}
my $undeclared = &CheckEmpty("$DOC_MODULE-undeclared.txt",
'undeclared symbols');
my $unused = &CheckEmpty("$DOC_MODULE-unused.txt",
'unused documentation entries');
my $failed = ($total > 0) + ($undeclared != 0) + ($unused != 0);
my $rate = 100.0*($checks - $failed)/$checks;
printf "%.1f%%: Checks %d, Failures: %d\n", $rate, $checks, $failed;
exit ($failed != 0);
sub Grep() {
my ($regexp, $filename, $what) = @_;
my $retval;
if (not open GFILE, "<$filename") {
die "Cannot open $filename: $!\n";
}
while (<GFILE>) {
next if not m/$regexp/;
$retval = $1;
last;
}
close GFILE;
if (not defined $retval) {
die "Cannot find $what in $filename\n";
}
return $retval;
}
sub CheckEmpty() {
my ($filename, $what) = @_;
my $count = 0;
if (not open GFILE, "<$filename") {
return $count;
}
while (<GFILE>) {
if (m/\S/) {
$count++
}
}
close GFILE;
if ($count) {
print "$filename:1:E: $count $what\n"
}
return $count;
}
|
