[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 18:03 -------
(In reply to comment #2)
> That looks great in theory.  Have you tried it just via
> manual renaming?  If so, then it is only a matter of
> changing the names at 'make install' time or earlier.

Unfortunately, just changing the names isn't enough.  After changing the name
and running /usr/sbin/makewhatis, I get this:

# man -k strlen
strlen               (3)  - calculate the length of a string
strlen               (3p)  - get string length
strlen [stap]        (3stap)  - Returns the length of a string
strlen [string]      (3)  - string operations
# man stap.strlen
STRLEN(3stap)           A collection of standard strin           STRLEN(3stap)
...

There are 2 problems there.  First, man reports the wrong name of the manpage
('stap' vs 'stap.strlen').  Second, the man page doesn't know it's "real" name
(that first line should read something like "STAP.STRLEN(3stap)").

For comparison's sake of the latter problem, here's how the first line of the
'Text::Abbrev' page looks:
# man Text::Abbrev
Text::Abbrev(3pm)      Perl Programmers Reference Guide      Text::Abbrev(3pm)

So, I tried a prefix of 'stap_'.  Here's what I get:
# 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

So, it looks like a prefix using '.' isn't going to work.  Obviously 'stap_'
works - I'd bet 'stap:' would work also.

> Do we need to retain the "3stap" suffix in this case?

It doesn't hurt - I'd probably keep it.  For example, all the perl manpages have
a 3pm suffix.  We could shorten it (a bit) to '3stp' if you'd like that better.
 Keeping the suffix would allow searching for all manpages related to systemtap.

-- 


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.