Summary: | man pages from tapset should not go under /usr/share/man/man5 | ||
---|---|---|---|
Product: | systemtap | Reporter: | Frank Ch. Eigler <fche> |
Component: | documentation | Assignee: | William Cohen <wcohen> |
Status: | RESOLVED FIXED | ||
Severity: | normal | CC: | wcohen |
Priority: | P2 | ||
Version: | unspecified | ||
Target Milestone: | --- | ||
Host: | Target: | ||
Build: | Last reconfirmed: |
Description
Frank Ch. Eigler
2009-02-19 17:55:05 UTC
There is a script being written to reduce the number of small man pages: systemtap/doc/Tapset_Reference_Guide/manpager.sh It currently expects to be run in the systemtap source directory rather than in the build directory. Modified the code and systemtap.spec to put the man pages generated from the tapsets into man3stap. Need to use "-S 3stap" option with man to get the man pages generated from the tapsets, e.g. "man -S 3stap user_mode". (In reply to comment #2) > Modified the code and systemtap.spec to put the man pages generated from the > tapsets into man3stap. Need to use "-S 3stap" option OK, this should also get mentioned in the NEWS. What do you advise about the stap{probes,...}.5 man pages? The thought was to rename the files to to en up in man3stap directory and fixup any references in the text to section 5. automake only understand man pages of the form man[0-9nl]. http://sources.redhat.com/automake/automake.html#Man-pages This makes it more difficult to get the other remaining manpage from man5 in the more appropriate man3stap directory with automake. The files in systemtap source that need to be moved: stapex.5.in stapfuncs.5.in stapprobes.5.in stapvars.5.in man/stapprobes.iosched.5.in man/stapprobes.rpc.5.in man/stapprobes.netdev.5.in man/stapprobes.scsi.5.in man/stapprobes.nfs.5.in man/stapprobes.signal.5.in man/stapprobes.nfsd.5.in man/stapprobes.socket.5.in man/stapprobes.pagefault.5.in man/stapprobes.tcp.5.in man/stapprobes.process.5.in man/stapprobes.udp.5.in automake doesn't create directories like /usr/share/man3stap. It can only do things like /usr/share/man[0-9nl]. Looking around in the man directories has turned up that perl and ssl just putting things in the regular man directories: $ rpm -qf /usr/share/man/man3/App::Prove.3pm.gz perl-5.10.0-56.fc10.x86_64 $ rpm -qf /usr/share/man/man3/BN_zero.3ssl.gz openssl-devel-0.9.8g-12.fc10.x86_64 Propose the following: 1) Getrid of man3stap directory and keep the .3stap ending on the man pages for the tapset manpages. 2) Move the following man pages to /usr/share/man3 with .3stap suffix stapex.5.in stapfuncs.5.in stapprobes.5.in stapvars.5.in man/stapprobes.iosched.5.in man/stapprobes.rpc.5.in man/stapprobes.netdev.5.in man/stapprobes.scsi.5.in man/stapprobes.nfs.5.in man/stapprobes.signal.5.in man/stapprobes.nfsd.5.in man/stapprobes.socket.5.in man/stapprobes.pagefault.5.in man/stapprobes.tcp.5.in man/stapprobes.process.5.in man/stapprobes.udp.5.in Implemented the changes in comment #6 with git commits: d9e3e39eef31587ea762f4b017b46495f7a0b70f e97c0b2970dfd8c23163d2712557a30401c75282 Verified that rpmbuild works both with and without the tapset documentation being built. The man pages generated from the tapsets are now 3stap man pages. |