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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
#!/bin/sh
# PCP QA Test No. 1251
# basic man(1) workout for man pages
#
# Copyright (c) 2020 Ken McDonell. All Rights Reserved.
#
# Note:
# if the platform and/or installer is sloppy, the apropos/whatis
# index may not have been rebuild after a PCP install, this usually
# requires running (as root) one of mandb(1) or makewhatis(1) or
# ...
# To check, try man -k ls ... if this reports
# ls: nothing appropriate
# (or similar), then this test is never going to pass until the
# appropriate command is run to rebuild the index
#
seq=`basename $0`
if [ $# -eq 0 ]
then
echo "QA output created by $seq"
else
echo "QA output created by $seq $*"
fi
# get standard environment, filters and checks
. ./common.product
. ./common.filter
. ./common.check
which man >/dev/null 2>&1 || _notrun "No man(1) command?"
_cleanup()
{
cd $here
$sudo rm -rf $tmp $tmp.*
}
# run man -k and filter out noise ...
#
_run_man_k()
{
LANG=POSIX LC_MESSAGES=POSIX man -k "$1" 2>$tmp.err \
| sed \
-e "/^$1: nothing appropriate/d" \
-e 's/_//g' \
-e 's/.//g' \
-e 's/[ ][ ]*/ /g' \
# end
}
_run_man_k "ls" >$tmp.out
if [ -s $tmp.out ]
then
if grep 'system has been minimized by removing packages' $tmp.out >/dev/null
then
rm -f $tmp.*
_notrun "man pages have been \"minimized\" away! container in CI?"
fi
# may be OK
else
_notrun "man -k ls won't even work ... apropos/whatis index needs rebuilding?"
fi
status=1 # failure is the default!
trap "_cleanup; exit \$status" 0 1 2 3 15
rm -f $seq.out
# check to see if filenames are used in the whatis/apropos index, or
# is the index based on the .SH NAME sections of the man page ...
# KERNEL_PMDAS is usually a file, mentioned in the .TH and the .xM
# macro and NOT the .SH NAME section
#
_run_man_k KERNEL_PMDAS >$tmp.tmp
if [ -s $tmp.tmp ]
then
ln $seq.out.xM $seq.out
xM=true
else
ln $seq.out.no_xM $seq.out
xM=false
fi
# real QA test starts here
cat <<'End-of-File' | sed -e '/^#/d' -e '/^[ ]*$/d' | while read sect key altname pat
# section keyword altname grep -E for text in man page
# for keyword, avoid case aliasing (different man's have different rules)
# and use (one of) the .SH NAME names
#
# no man page, check logic
1 really_fubar - beyond all recognition
# no matching text, check logic
1 pminfo - fubar
# simple section 1 entry
1 pminfo - .-T, *--helptext
# composite section 1 entry
1 pmdatxmon - tx_type
1 txrecord pmdatxmon tx_type
1 genload pmdatxmon tx_type
# aliased (xM) section 1 entry
1 KERNEL_PMDAS - usually running as shared libraries
# special case section 1 and 3 entry
1 PCPIntro - Co-Pilot
3 PCPIntro - Co-Pilot
# simple section 3 entry
3 pmNewContext - PM_CONTEXT_ARCHIVE
# composite and aliased (xM) section 3 entry
3 pmRecord - pmRecordHost
3 pmRecordSetup pmRecord pmRecordHost
3 pmRecordControl (pmRecord|pmRecordSetup) pmRecordHost
# weirdos
5 pcp.env - \.pcp/pcp.conf
End-of-File
do
# *BSD man(1) really uses apropos(1) for man -k which uses a full
# text searching, so all we can try to match on here is
# for each man section
#
if $xM
then
:
else
case "$key"
in
KERNEL_PMDAS|pmRecord)
continue
;;
esac
fi
echo | tee -a $seq_full
echo "=== $key ===" | tee -a $seq_full
lc_key=`echo "$key" | tr '[A-Z]' '[a-z']`
lc_altname=`echo "$altname" | tr '[A-Z]' '[a-z']`
_run_man_k "$key" >$tmp.out
if [ -s $tmp.out ]
then
tr '[A-Z]' '[a-z'] <$tmp.out >$tmp.tmp
if grep -E "^$lc_key *\($sect" $tmp.tmp >/dev/null
then
# matching simple entry found from man -k
:
elif [ X"$altname" != X- ] && grep -E "^$lc_altname *\($sect" $tmp.tmp >/dev/null
then
# matching altname entry found from man -k ... needed for
# *BSD where man -k is really apropos and *BSD apropos does
# not build index entries for symlink'd man pages
#
:
elif grep "^$lc_key *\[[^ ]*] *($sect" $tmp.tmp >/dev/null
then
# Slackware type whatis, [...] is magically crafted from .TH
# arguments, e.g.
# pcp.env [pcp] (5) - script ...
:
elif grep "\[$lc_key] *($sect" $tmp.tmp >/dev/null
then
# Slackware type whatis, [...] is our .xM string, not a keyword
# at the start of the line, e.g.
# pmRecordAddHost [pmRecord] (3) - record ...
:
elif grep "^$lc_key, .*($sect" $tmp.tmp >/dev/null
then
# FreeBSD 12.0 style with all the .SH NAME options on the
# same line and the first entry in the list, e.g. pmconfirm
# below:
# pmconfirm, pmmessage, pmquery(1) - general ...
:
elif grep " $lc_key, .*($sect" $tmp.tmp >/dev/null
then
# FreeBSD 12.0 style with all the .SH NAME options on the
# same line and a middle entry in the list, e.g. pmmessage
# below:
# pmconfirm, pmmessage, pmquery(1) - general ...
:
elif grep " $lc_key($sect" $tmp.tmp >/dev/null
then
# FreeBSD 12.0 style with all the .SH NAME options on the
# same line and the last entry in the list, e.g. pmquery
# below;
# pmconfirm, pmmessage, pmquery(1) - general ...
:
else
# no matching entry from man -k
cat $tmp.out >>$seq_full
cat $tmp.err >>$seq_full
echo "No matching man entry for section $sect"
fi
else
# no output from man -k
cat $tmp.out >>$seq_full
cat $tmp.err >>$seq_full
echo "No matching man entry in any section!"
fi
echo "--- ($sect) ---" | tee -a $seq_full
TERM=dumb LANG=POSIX LC_MESSAGES=POSIX man $sect $key 2>&1 \
| sed -e 's/_//g' -e 's/.//g' -e 's/[ ][ ]*/ /g' >$tmp.out
if grep -E "$pat" $tmp.out >/dev/null
then
echo OK
else
cat $tmp.out >>$seq_full
echo "No match for pattern $pat"
fi
done
# success, all done
status=0
exit
|
