Bug 9870 - man pages from tapset should not go under /usr/share/man/man5
Summary: man pages from tapset should not go under /usr/share/man/man5
Status: RESOLVED FIXED
Alias: None
Product: systemtap
Classification: Unclassified
Component: documentation (show other bugs)
Version: unspecified
: P2 normal
Target Milestone: ---
Assignee: William Cohen
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2009-02-19 17:55 UTC by Frank Ch. Eigler
Modified: 2009-03-26 14:21 UTC (History)
1 user (show)

See Also:
Host:
Target:
Build:
Last reconfirmed:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Frank Ch. Eigler 2009-02-19 17:55:05 UTC
Many generated files have such generic names that they should
be segregated from the standard man page suite:

/usr/share/man/man5/caller.5.gz
/usr/share/man/man5/caller_addr.5.gz
/usr/share/man/man5/cpu.5.gz
/usr/share/man/man5/egid.5.gz
/usr/share/man/man5/euid.5.gz
/usr/share/man/man5/execname.5.gz
/usr/share/man/man5/get_cycles.5.gz

Fixing this could mean aggregating them in per-tapset rather than
per-function files, or placing them into some man subdirectory.

Manual section 5 doesn't seem appropriate for our man pages in
general; maybe section 3 (or "3stap") instead.
Comment 1 William Cohen 2009-03-18 18:53:23 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. 
Comment 2 William Cohen 2009-03-18 20:56:54 UTC
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".

Comment 3 Frank Ch. Eigler 2009-03-18 21:08:03 UTC
(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?
Comment 4 William Cohen 2009-03-18 21:32:56 UTC
The thought was to rename the files to to en up in man3stap directory and fixup
any references in the text to section 5.

Comment 5 William Cohen 2009-03-23 16:20:33 UTC
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
Comment 6 William Cohen 2009-03-24 15:15:46 UTC
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
Comment 7 William Cohen 2009-03-24 16:17:38 UTC
Implemented the changes in comment #6 with git commits:

d9e3e39eef31587ea762f4b017b46495f7a0b70f
e97c0b2970dfd8c23163d2712557a30401c75282

Verified that rpmbuild works both with and without the tapset documentation
being built.
Comment 8 William Cohen 2009-03-26 14:21:07 UTC
The man pages generated from the tapsets are now 3stap man pages.