Bug 7855

Summary: incorrect manpage section suffix
Product: xorg Reporter: Drew Parsons <dparsons>
Component: Lib/XiAssignee: Xorg Project Team <xorg-team>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: high    
Version: 7.1 (2006.05)   
Hardware: x86 (IA32)   
OS: Linux (All)   
Whiteboard:
i915 platform: i915 features:
Attachments:
Description Flags
sets manpage suffices using macro none

Description Drew Parsons 2006-08-12 04:08:26 UTC 
At the moment the libxi man pages are assigned to section 3X11.  This is
incorrect and clashes with the value used for the linked (shadow) manpages, such
as XGetDeviceControl, which use the macro LIB_MAN_SUFFIX.

The attached patch fixes the problem by changing the value in the .man files to
__LIB_MAN_SUFFIX__, and setting it at build time to the correct value
$(LIB_MAN_SUFFIX) using a sed operation, as is already done for __xorgversion__.

As I am not certain when @LIB_MAN_SUFFIX@ needs to be used instead of
$(LIB_MAN_SUFFIX) in Makefile.am (both get used in shadows.DONE:), I can leave
this bug open for comments for a couple of weeks before applying the patch
myself.  After that I'll patch any other affected libraries as I find them.

Drew

p.s. xorg-macros.m4 defines LIB_MAN_SUFFIX as 3x for linux and 3 for anything
else.  I think it should be 3 for everyone, in line with the modular X11R7 act
of removing the /usr/X11 special directory, putting everything in standard
/usr/include, /usr/lib. Debian and ubuntu have patched it already.  But anyway,
this is a matter for separate discussion in a separate bug report.
Comment 1 Drew Parsons 2006-08-12 04:12:56 UTC 
Created attachment 6530 [details] [review]
sets manpage suffices using macro

Based on patch by Fabio M. Di Nitto c/- Colin Watson, Debian Bug#377204.
Comment 2 Daniel Stone 2006-08-12 05:40:32 UTC 
(In reply to comment #0)
> p.s. xorg-macros.m4 defines LIB_MAN_SUFFIX as 3x for linux and 3 for anything
> else.  I think it should be 3 for everyone, in line with the modular X11R7 act
> of removing the /usr/X11 special directory, putting everything in standard
> /usr/include, /usr/lib. Debian and ubuntu have patched it already.  But anyway,
> this is a matter for separate discussion in a separate bug report.

yes please.
Comment 3 Alan Coopersmith 2006-08-14 14:15:16 UTC 
Patch committed - thanks!

(As for the other discussion, yes, please open another bug - the biggest obstacle
 to changing the Linux suffixes is doing the work of updating and re-releasing 
 all the relevant packages.   When I made them different, I was simply copying 
 the Imake settings and no one said that wasn't what the distros wanted to keep 
 doing.)

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.