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
|
#!/bin/bash
# This script builds overview man pages for each tapset from the doc
# comments in the tapset source. As such, the man page content
# generated herein should be in sync with the SystemTap Tapset
# Reference.
# If testing manually, just run this script with
# doc/SystemTap_Tapset_Reference as the working directory
# and the SRCTREE variable set to the location of your
# systemtap source tree.
echo "Starting manpager in" `pwd`
# cleanup
rm -rf man_pages
# create working directory
mkdir workingdir ;
# create list of man pages to generate
cat $SRCTREE/doc/SystemTap_Tapset_Reference/tapsets.tmpl | grep ^\!Itapset > manpageus ;
sed -i -e 's/\!Itapset\///g' manpageus ;
# copy list of man pages into working directory
# with similar basenames concatenated
for i in `cat manpageus` ; do
b=`basename $i | sed -e 's/.stpm$/.stp/'`
cat $SRCTREE/tapset/$i >>workingdir/$b ;
done ;
# rewrite manpageus to the resulting files
ls workingdir >manpageus
# enter workdir
cd workingdir ;
# copy tapsetdescriptions, then clean
for i in `cat ../manpageus`; do
sed -n '/\/\/ <tapsetdescription>/,/\/\/ <\/tapsetdescription>/ s/.*/&/w temp' < $i ;
mv temp $i.tapsetdescription ;
sed -i -e 's/\/\/ <tapsetdescription>//g' $i.tapsetdescription ;
sed -i -e 's/\/\/ <\/tapsetdescription>//g' $i.tapsetdescription ;
sed -i -e 's/\/\///g' $i.tapsetdescription ;
# XXX: may want to trim whitespace from description edges
done
# strip all tapset files to just comments; but all comments must be exactly 1 space before and after "*"
for i in `cat ../manpageus` ; do
sed -i -e 's/^ \*/ \*/g' $i;
sed -i -e 's/^ \* / \* /g' $i;
# mark the start of each probe entry (sub "/**")
perl -p -i -e 's|^/\*\*| *probestart|g' $i;
sed -i -e '/^ \*/!d' $i;
# rename all tapsets (remove .stp/.stpm filename suffix), create templates
echo $i > tempname ;
sed -i -e 's/.stpm*$//g' tempname ;
mv $i `cat tempname` ; mv tempname $i ;
done ;
# create man page headers
date=`date "+%B %Y"`
for i in `ls | grep -v .stp | grep -v tapsetdescription` ; do
icap=`echo $i | tr a-z A-Z`
echo ".\\\" -*- nroff -*-" >> $i.template ;
echo ".TH TAPSET::"$icap" 3stap \"$date\" \"SystemTap Tapset Reference\"" >> $i.template ;
echo ".SH NAME" >> $i.template ;
echo "tapset::"`cat $i.stp`" \- systemtap "`cat $i.stp`" tapset" >> $i.template ;
echo " " >> $i.template ;
echo ".SH DESCRIPTION" >> $i.template ;
cat $i.stp.tapsetdescription >> $i.template ;
echo ".TP" >> $i.template ;
done
# clean man page body
sed -i -e 's/\.stp$//g' ../manpageus ;
for i in `cat ../manpageus` ; do
mv $i $i.tmp ;
perl -e 'while(<>){print"$1\n"if/ \* probe ([^\n]*) -/;}' $i.tmp >$i.probenames;
perl -e 'while(<>){print"$1\n"if/ \* sfunction ([^\n]*) -/;}' $i.tmp >$i.funcnames;
perl -e 'while(<>){print"$1\n"if/ \* smacro ([^\n]*) -/;}' $i.tmp >$i.macros;
# perl -p -i -e 's/ \* (probe|sfunction) ([^\n]*)\n/.P\n.TP\n.B $1 \n $2\n$3\n
perl -p -i -e 's/ \* sfunction ([^\n]*) - ([^\n]*)\n/.P\n.TP\n.B $1 \n$2\n.IP\nSee \n.IR function::$1 \(3stap\)\n for details.\n/g' $i.tmp ;
perl -p -i -e 's/ \* probe ([^\n]*) - ([^\n]*)\n/.P\n.TP\n.B $1 \n$2\n.IP\n See \n.IR probe::$1 \(3stap\)\n for details.\n/g' $i.tmp ;
perl -p -i -e 's/ \* smacro ([^\n]*) - ([^\n]*)\n/.P\n.TP\n.B \@$1 \n$2\n.IP\n See \n.IR macro::$1 \(3stap\)\n for details.\n/g' $i.tmp ;
# XXX: the people hunger for argument descriptions, which would be extracted here
perl -p -i -e 's/ \*([^\n]*)\n//g' $i.tmp ; # nuke the rest of it
done
# generate footer template
for i in `cat ../manpageus` ; do
echo "" >> $i.footer
echo ".SH SEE ALSO" >> $i.footer
for j in `cat $i.funcnames | uniq` ; do
echo ".BR" >> $i.footer
echo ".IR \\%function::"$j" (3stap)," >> $i.footer
done
for j in `cat $i.probenames` ; do
echo ".BR" >> $i.footer
echo ".IR \\%probe::"$j" (3stap)," >> $i.footer
done
for j in `cat $i.macros` ; do
echo ".BR" >> $i.footer
echo ".IR \\%macro::"$j" (3stap)," >> $i.footer
done
echo ".BR" >> $i.footer
echo ".IR \\%stap (1)," >> $i.footer
echo ".IR \\%stapprobes (3stap)" >> $i.footer
done
# add cross reference to enclosed functions and probes
for i in `cat ../manpageus` ; do
for j in `cat $i.funcnames | uniq` ; do
echo ".SH SEE ALSO\n " >> ../man3/function::$j.3stap
echo ".IR tapset::$i (3stap)" >> ../man3/function::$j.3stap
done
for j in `cat $i.probenames` ; do
echo ".SH SEE ALSO\n " >> ../man3/probe::$j.3stap
echo ".IR tapset::$i (3stap)" >> ../man3/probe::$j.3stap
done
for j in `cat $i.macros` ; do
echo ".SH SEE ALSO\n " >> ../man3/macro::$j.3stap
echo ".IR tapset::$i (3stap)" >> ../man3/macro::$j.3stap
done
done
# assemble parts
for i in `cat ../manpageus`; do
cat $i.template >> tapset\:\:$i.3stap ;
cat $i.tmp >> tapset\:\:$i.3stap ;
cat $i.footer >> tapset\:\:$i.3stap ;
# final polish
sed -i -e 's/\*\/$//g' tapset\:\:$i.3stap ;
done
# cleanup
for i in `ls | grep -v -e "tapset::.*\\.3stap"` ; do
rm $i ;
done
rm ../manpageus ;
cd ..
mv workingdir man_pages
echo " "
echo "Finished! man pages generated in ./man_pages."
echo " "
|
