[Bug documentation/11210] 3stap man pages colliding with 3

["dsmith at redhat dot com" <sourceware-bugzilla at sourceware dot org>]

------- Additional Comments From dsmith at redhat dot com  2010-02-05 16:39 -------
I've looked into this a bit.  I haven't found any specific fedora guidelines on
this problem.

While it is technically possible to change the system manpath section path and
add new directories, I don't think it is wise.  I've been looking, and I haven't
found any other package that does anything similar - everyone just uses the FHS
directories.

Another possible (not so good) solution would be to change the manpage section
we use.  Instead of using section 3, we could (abuse) section 8 since everything
systemtap related is administrator related.

I'm really thinking the best solution is prefixing our symbols with something. 
For an example, look at this:

# man -k abbrev
abbrev [Text::Abbrev] (3pm)  - create an abbreviation table from a list

This is from a perl manpage.  See the '[Text::Abbrev]' part?  That is 'man'
telling us what the actual filename of the manpage is, as opposed to the
'logical' name.  To see that manpage, you have to type "man Text::Abbrev".

If we prefix the symbols with 'stap.' (which will require some manpage
generation changes), the output would look something like this:
# man -k strlen
strlen               (3)  - calculate the length of a string
strlen               (3p)  - get string length
strlen [stap.strlen] (3stap)  - Returns the length of a string
strlen [string]      (3)  - string operations
# man stap.strlen
... stap strlen manpage displayed ...
# man strlen
... the "real" strlen manpage displayed ...

-- 


http://sourceware.org/bugzilla/show_bug.cgi?id=11210

------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.