summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rwxr-xr-xdoc/SystemTap_Tapset_Reference/manpager17
-rw-r--r--man/README7
2 files changed, 21 insertions, 3 deletions
diff --git a/doc/SystemTap_Tapset_Reference/manpager b/doc/SystemTap_Tapset_Reference/manpager
index 6a905a2bf..b1baebcaf 100755
--- a/doc/SystemTap_Tapset_Reference/manpager
+++ b/doc/SystemTap_Tapset_Reference/manpager
@@ -110,17 +110,23 @@ for i in `cat ../manpageus` ; do
110done 110done
111 111
112# add cross reference to enclosed functions and probes 112# add cross reference to enclosed functions and probes
113for i in ../man3/{function,probe,macro}::*.3stap; do
114 sed -i '/^\.SH SEE ALSO/,$d' $i
115done
113for i in `cat ../manpageus` ; do 116for i in `cat ../manpageus` ; do
114 for j in `cat $i.funcnames | uniq` ; do 117 for j in `cat $i.funcnames | uniq` ; do
115 echo ".SH SEE ALSO\n " >> ../man3/function::$j.3stap 118 grep -q '^.SH SEE ALSO' ../man3/function::$j.3stap || \
119 echo ".SH SEE ALSO\n " >> ../man3/function::$j.3stap
116 echo ".IR tapset::$i (3stap)" >> ../man3/function::$j.3stap 120 echo ".IR tapset::$i (3stap)" >> ../man3/function::$j.3stap
117 done 121 done
118 for j in `cat $i.probenames` ; do 122 for j in `cat $i.probenames` ; do
119 echo ".SH SEE ALSO\n " >> ../man3/probe::$j.3stap 123 grep -q '^.SH SEE ALSO' ../man3/probe::$j.3stap || \
124 echo ".SH SEE ALSO\n " >> ../man3/probe::$j.3stap
120 echo ".IR tapset::$i (3stap)" >> ../man3/probe::$j.3stap 125 echo ".IR tapset::$i (3stap)" >> ../man3/probe::$j.3stap
121 done 126 done
122 for j in `cat $i.macros` ; do 127 for j in `cat $i.macros` ; do
123 echo ".SH SEE ALSO\n " >> ../man3/macro::$j.3stap 128 grep -q '^.SH SEE ALSO' ../man3/macro::$j.3stap || \
129 echo ".SH SEE ALSO\n " >> ../man3/macro::$j.3stap
124 echo ".IR tapset::$i (3stap)" >> ../man3/macro::$j.3stap 130 echo ".IR tapset::$i (3stap)" >> ../man3/macro::$j.3stap
125 done 131 done
126done 132done
@@ -139,6 +145,11 @@ for i in `ls | grep -v -e "tapset::.*\\.3stap"` ; do
139 rm $i ; 145 rm $i ;
140done 146done
141 147
148# PR30965 replacements
149for i in ../man3/probe\:\:*; do
150 sed -i '/^\.SH "SYNOPSIS"$/,/^\.SH/s/^[^\.].*$/probe \0{}/' $i
151done
152
142rm ../manpageus ; 153rm ../manpageus ;
143cd .. 154cd ..
144mv workingdir man_pages 155mv workingdir man_pages
diff --git a/man/README b/man/README
new file mode 100644
index 000000000..66bc08816
--- /dev/null
+++ b/man/README
@@ -0,0 +1,7 @@
1How to regenerate the manpages
2------------------------------------
31) ./configure --enable-docs --enable-refdocs --enable-htmldocs
42) make # this creates doc/SystemTap_Tapset_Reference/tapsets.xml
53) cd doc/SystemTap_Tapset_Reference
63) xmlto man tapsets.xml -o man3 # this regens the manpage content
74) ./manpager # adds the SEE ALSO sections (cross references) to the manpages