blob: b27a405e4ddb1a97e31c6573f2307b48e103013d (
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
#!/usr/bin/perl
my $doc_file = "/docs/docbook/manpages/smb.conf.5.sgml";
my $source_file = "/source/param/loadparm.c";
my %link,%doc,%param;
# This one shouldn't be documented at all
$doc{-valid} = "FOUND";
$topdir = (shift @ARGV) or $topdir = ".";
##################################################
# Reading links from manpage
open(IN,$topdir.$doc_file);
while(<IN>) {
if( /<listitem><para><link linkend="([^"]*)"><parameter>([^<]*)<\/parameter><\/link><\/para><\/listitem>/g ){
$link{$2} = $1;
$ref{$1} = $2;
}
}
close(IN);
##################################################
# Reading documentation from manpage
open(IN,$topdir.$doc_file) || die("Can't open $topdir$doc_file");
while(<IN>) {
if( /<term><anchor id="([^"]*)"\/>([^<]*?)([ ]*)\(.\)([ ]*)<\/term>/g ) {
$key = $1;
$value = $2;
$doc{$value} = $key;
# There is a reference to this entry
if($ref{$key} eq $value){
$ref{$key} = "FOUND";
} else {
if($ref{$key}) {
print "$key should refer to $value, but refers to " . $ref{$key} . "\n";
} else {
print "$key should refer to $value, but has no reference!\n";
}
$ref{$key} = $value;
}
}
}
close(IN);
#################################################
# Reading entries from source code
open(SOURCE,$topdir.$source_file) || die("Can't open $topdir$source_file");
while ($ln = <SOURCE>) {
last if $ln =~ m/^static\ struct\ parm_struct\ parm_table.*/;
} #burn through the preceding lines
while ($ln = <SOURCE>) {
last if $ln =~ m/^\s*\}\;\s*$/;
#pull in the param names only
next if $ln =~ m/.*P_SEPARATOR.*/;
next unless $ln =~ /.*\"(.*)\".*/;
if($doc{lc($1)}) {
$doc{lc($1)} = "FOUND";
} else {
print "$1 is not documented!\n";
}
}
close SOURCE;
##################################################
# Trying to find missing references
foreach (keys %ref) {
if($ref{$_} cmp "FOUND") {
print "$_ references to " . $ref{$_} . ", but " . $ref{$_} . " isn't an anchor!\n";
}
}
foreach (keys %doc) {
if($doc{$_} cmp "FOUND") {
print "$_ is documented but is not a configuration option!\n";
}
}
|
