| 1 |
#!/bin/bash |
| 2 |
|
| 3 |
# This script builds overview man pages for each tapset from the doc |
| 4 |
# comments in the tapset source. As such, the man page content |
| 5 |
# generated herein should be in sync with the SystemTap Tapset |
| 6 |
# Reference. |
| 7 |
|
| 8 |
# If testing manually, just run this script with |
| 9 |
# doc/SystemTap_Tapset_Reference as the working directory |
| 10 |
# and the SRCTREE variable set to the location of your |
| 11 |
# systemtap source tree. |
| 12 |
|
| 13 |
echo "Starting manpager in" `pwd` |
| 14 |
|
| 15 |
# cleanup |
| 16 |
rm -rf man_pages |
| 17 |
|
| 18 |
# create working directory |
| 19 |
mkdir workingdir ; |
| 20 |
|
| 21 |
# create list of man pages to generate |
| 22 |
cat $SRCTREE/doc/SystemTap_Tapset_Reference/tapsets.tmpl | grep ^\!Itapset > manpageus ; |
| 23 |
sed -i -e 's/\!Itapset\///g' manpageus ; |
| 24 |
|
| 25 |
# copy list of man pages into working directory |
| 26 |
# with similar basenames concatenated |
| 27 |
for i in `cat manpageus` ; do |
| 28 |
b=`basename $i | sed -e 's/.stpm$/.stp/'` |
| 29 |
cat $SRCTREE/tapset/$i >>workingdir/$b ; |
| 30 |
done ; |
| 31 |
|
| 32 |
# rewrite manpageus to the resulting files |
| 33 |
ls workingdir >manpageus |
| 34 |
|
| 35 |
# enter workdir |
| 36 |
cd workingdir ; |
| 37 |
|
| 38 |
# copy tapsetdescriptions, then clean |
| 39 |
for i in `cat ../manpageus`; do |
| 40 |
sed -n '/\/\/ <tapsetdescription>/,/\/\/ <\/tapsetdescription>/ s/.*/&/w temp' < $i ; |
| 41 |
mv temp $i.tapsetdescription ; |
| 42 |
sed -i -e 's/\/\/ <tapsetdescription>//g' $i.tapsetdescription ; |
| 43 |
sed -i -e 's/\/\/ <\/tapsetdescription>//g' $i.tapsetdescription ; |
| 44 |
sed -i -e 's/\/\///g' $i.tapsetdescription ; |
| 45 |
# XXX: may want to trim whitespace from description edges |
| 46 |
done |
| 47 |
|
| 48 |
# strip all tapset files to just comments; but all comments must be exactly 1 space before and after "*" |
| 49 |
for i in `cat ../manpageus` ; do |
| 50 |
sed -i -e 's/^ \*/ \*/g' $i; |
| 51 |
sed -i -e 's/^ \* / \* /g' $i; |
| 52 |
# mark the start of each probe entry (sub "/**") |
| 53 |
perl -p -i -e 's|^/\*\*| *probestart|g' $i; |
| 54 |
sed -i -e '/^ \*/!d' $i; |
| 55 |
# rename all tapsets (remove .stp/.stpm filename suffix), create templates |
| 56 |
echo $i > tempname ; |
| 57 |
sed -i -e 's/.stpm*$//g' tempname ; |
| 58 |
mv $i `cat tempname` ; mv tempname $i ; |
| 59 |
done ; |
| 60 |
|
| 61 |
# create man page headers |
| 62 |
date=`date "+%B %Y"` |
| 63 |
for i in `ls | grep -v .stp | grep -v tapsetdescription` ; do |
| 64 |
icap=`echo $i | tr a-z A-Z` |
| 65 |
echo ".\\\" -*- nroff -*-" >> $i.template ; |
| 66 |
echo ".TH TAPSET::"$icap" 3stap \"$date\" \"SystemTap Tapset Reference\"" >> $i.template ; |
| 67 |
echo ".SH NAME" >> $i.template ; |
| 68 |
echo "tapset::"`cat $i.stp`" \- systemtap "`cat $i.stp`" tapset" >> $i.template ; |
| 69 |
echo " " >> $i.template ; |
| 70 |
echo ".SH DESCRIPTION" >> $i.template ; |
| 71 |
cat $i.stp.tapsetdescription >> $i.template ; |
| 72 |
echo ".TP" >> $i.template ; |
| 73 |
done |
| 74 |
|
| 75 |
# clean man page body |
| 76 |
sed -i -e 's/\.stp$//g' ../manpageus ; |
| 77 |
for i in `cat ../manpageus` ; do |
| 78 |
mv $i $i.tmp ; |
| 79 |
|
| 80 |
perl -e 'while(<>){print"$1\n"if/ \* probe ([^\n]*) -/;}' $i.tmp >$i.probenames; |
| 81 |
perl -e 'while(<>){print"$1\n"if/ \* sfunction ([^\n]*) -/;}' $i.tmp >$i.funcnames; |
| 82 |
perl -e 'while(<>){print"$1\n"if/ \* smacro ([^\n]*) -/;}' $i.tmp >$i.macros; |
| 83 |
# perl -p -i -e 's/ \* (probe|sfunction) ([^\n]*)\n/.P\n.TP\n.B $1 \n $2\n$3\n |
| 84 |
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 ; |
| 85 |
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 ; |
| 86 |
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 ; |
| 87 |
# XXX: the people hunger for argument descriptions, which would be extracted here |
| 88 |
perl -p -i -e 's/ \*([^\n]*)\n//g' $i.tmp ; # nuke the rest of it |
| 89 |
done |
| 90 |
|
| 91 |
# generate footer template |
| 92 |
for i in `cat ../manpageus` ; do |
| 93 |
echo "" >> $i.footer |
| 94 |
echo ".SH SEE ALSO" >> $i.footer |
| 95 |
for j in `cat $i.funcnames | uniq` ; do |
| 96 |
echo ".BR" >> $i.footer |
| 97 |
echo ".IR \\%function::"$j" (3stap)," >> $i.footer |
| 98 |
done |
| 99 |
for j in `cat $i.probenames` ; do |
| 100 |
echo ".BR" >> $i.footer |
| 101 |
echo ".IR \\%probe::"$j" (3stap)," >> $i.footer |
| 102 |
done |
| 103 |
for j in `cat $i.macros` ; do |
| 104 |
echo ".BR" >> $i.footer |
| 105 |
echo ".IR \\%macro::"$j" (3stap)," >> $i.footer |
| 106 |
done |
| 107 |
echo ".BR" >> $i.footer |
| 108 |
echo ".IR \\%stap (1)," >> $i.footer |
| 109 |
echo ".IR \\%stapprobes (3stap)" >> $i.footer |
| 110 |
done |
| 111 |
|
| 112 |
# add cross reference to enclosed functions and probes |
| 113 |
for i in `cat ../manpageus` ; do |
| 114 |
for j in `cat $i.funcnames | uniq` ; do |
| 115 |
echo ".SH SEE ALSO\n " >> ../man3/function::$j.3stap |
| 116 |
echo ".IR tapset::$i (3stap)" >> ../man3/function::$j.3stap |
| 117 |
done |
| 118 |
for j in `cat $i.probenames` ; do |
| 119 |
echo ".SH SEE ALSO\n " >> ../man3/probe::$j.3stap |
| 120 |
echo ".IR tapset::$i (3stap)" >> ../man3/probe::$j.3stap |
| 121 |
done |
| 122 |
for j in `cat $i.macros` ; do |
| 123 |
echo ".SH SEE ALSO\n " >> ../man3/macro::$j.3stap |
| 124 |
echo ".IR tapset::$i (3stap)" >> ../man3/macro::$j.3stap |
| 125 |
done |
| 126 |
done |
| 127 |
|
| 128 |
# assemble parts |
| 129 |
for i in `cat ../manpageus`; do |
| 130 |
cat $i.template >> tapset\:\:$i.3stap ; |
| 131 |
cat $i.tmp >> tapset\:\:$i.3stap ; |
| 132 |
cat $i.footer >> tapset\:\:$i.3stap ; |
| 133 |
# final polish |
| 134 |
sed -i -e 's/\*\/$//g' tapset\:\:$i.3stap ; |
| 135 |
done |
| 136 |
|
| 137 |
# cleanup |
| 138 |
for i in `ls | grep -v -e "tapset::.*\\.3stap"` ; do |
| 139 |
rm $i ; |
| 140 |
done |
| 141 |
|
| 142 |
rm ../manpageus ; |
| 143 |
cd .. |
| 144 |
mv workingdir man_pages |
| 145 |
echo " " |
| 146 |
echo "Finished! man pages generated in ./man_pages." |
| 147 |
echo " " |