Bug 9651 - Bad markup in XcmsColor.3x
Summary: Bad markup in XcmsColor.3x
Status: RESOLVED FIXED
Alias: None
Product: xorg
Classification: Unclassified
Component: Lib/other (show other bugs)
Version: unspecified
Hardware: x86 (IA32) Linux (All)
: high normal
Assignee: Xorg Project Team
QA Contact: Xorg Project Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-01-14 10:39 UTC by Eric S. Raymond
Modified: 2007-08-21 15:11 UTC (History)
0 users

See Also:
i915 platform:
i915 features:


Attachments

Description Eric S. Raymond 2007-01-14 10:39:36 UTC
Problems with XcmsColor.3x:

1. Use local definitions of .EX/.EE or .DS/.DE to avoid low-level troff
requests in the page body.  There are plans to add these to groff man;
in the interim, this patch adds a compatible definition to your page.

2. Use of low-level troff hackery to set special indents or breaks can't
be translated. The page will have rendering faults in HTML, and
probably also under third-party man page browsers such as Xman,
Rosetta, and the KDE help browser.  This patch eliminates .br, .ta, .ti
and .in in favor of requests like .nf/.fi, and .RS/.RE that have
structural translations.

--- XcmsColor.3x-orig	2007-01-14 02:38:15.000000000 -0500
+++ XcmsColor.3x	2007-01-14 02:39:08.000000000 -0500
@@ -140,6 +140,16 @@
 .el .sp 10p
 ..
 .ny0
+.de EX
+.sp
+.nf
+.ft CW
+..
+.de EE
+.ft R
+.fi
+.sp
+..
 .TH XcmsColor 3X11 "libX11 1.0.3" "X Version 11" "XLIB FUNCTIONS"
 .SH NAME
 XcmsColor, XcmsRGB, XcmsRGBi, XcmsCIEXYZ, XcmsCIEuvY, XcmsCIExyY, XcmsCIELab,
XcmsCIELuv, XcmsTekHVC, XcmsPad \- Xcms color struture
@@ -148,9 +158,7 @@
 .ZN XcmsColor
 contains:
 .LP
-.Ds 0
-.TA .5i 1i 2.5i
-.ta .5i 1i 2.5i
+.EX
 typedef unsigned long XcmsColorFormat;			/\(** Color Specification Format */
 
 typedef struct {
@@ -168,11 +176,9 @@
 	unsigned long pixel;
 	XcmsColorFormat format;
 } XcmsColor;			/\(** Xcms Color Structure */
-.De
+.EE
 .LP
-.Ds 0
-.TA .5i 2.5i
-.ta .5i 2.5i
+.EX
 typedef double XcmsFloat;
 
 typedef struct {
@@ -180,88 +186,72 @@
 	unsigned short green;	/\(** 0x0000 to 0xffff */
 	unsigned short blue;	/\(** 0x0000 to 0xffff */
 } XcmsRGB;		/\(** RGB Device */
-.De
+.EE
 .LP
-.Ds 0
-.TA .5i 2.5i
-.ta .5i 2.5i
+.EX
 typedef struct {
 	XcmsFloat red;	/\(** 0.0 to 1.0 */
 	XcmsFloat green;	/\(** 0.0 to 1.0 */
 	XcmsFloat blue;	/\(** 0.0 to 1.0 */
 } XcmsRGBi;		/\(** RGB Intensity */
-.De
+.EE
 .LP
-.Ds 0
-.TA .5i 2.5i
-.ta .5i 2.5i
+.EX
 typedef struct {
 	XcmsFloat X;
 	XcmsFloat Y;	/\(** 0.0 to 1.0 */
 	XcmsFloat Z;
 } XcmsCIEXYZ;		/\(** CIE XYZ */
-.De
+.EE
 .LP
-.Ds 0
-.TA .5i 2.5i
-.ta .5i 2.5i
+.EX
 typedef struct {
 	XcmsFloat u_prime;	/\(** 0.0 to ~0.6 */
 	XcmsFloat v_prime;	/\(** 0.0 to ~0.6 */
 	XcmsFloat Y; 	/\(** 0.0 to 1.0 */
 } XcmsCIEuvY;		/\(** CIE u'v'Y */
-.De
+.EE
 .LP
-.Ds 0
-.TA .5i 2.5i
-.ta .5i 2.5i
+.EX
 typedef struct {
 	XcmsFloat x; 	/\(** 0.0 to ~.75 */
 	XcmsFloat y; 	/\(** 0.0 to ~.85 */
 	XcmsFloat Y; 	/\(** 0.0 to 1.0 */
 } XcmsCIExyY;		/\(** CIE xyY */
-.De
+.EE
 .LP
-.Ds 0
-.TA .5i 2.5i
-.ta .5i 2.5i
+.EX
 typedef struct {
 	XcmsFloat L_star; 	/\(** 0.0 to 100.0 */
 	XcmsFloat a_star;
 	XcmsFloat b_star;
 } XcmsCIELab;		/\(** CIE L*a*b* */
-.De
+.EE
 .LP
-.Ds 0
-.TA .5i 2.5i
-.ta .5i 2.5i
+.EX
 typedef struct {
 	XcmsFloat L_star; 	/\(** 0.0 to 100.0 */
 	XcmsFloat u_star;
 	XcmsFloat v_star;
 } XcmsCIELuv;		/\(** CIE L*u*v* */
-.De
+.EE
 .LP
-.Ds 0
-.TA .5i 2.5i
-.ta .5i 2.5i
+.EX
 typedef struct {
 	XcmsFloat H; 	/\(** 0.0 to 360.0 */
 	XcmsFloat V; 	/\(** 0.0 to 100.0 */
 	XcmsFloat C; 	/\(** 0.0 to 100.0 */
 } XcmsTekHVC;		/\(** TekHVC */
-.De
+.EE
 .LP
-.Ds 0
-.TA .5i 2.5i
-.ta .5i 2.5i
+.EX
 typedef struct {
 	XcmsFloat pad0;
 	XcmsFloat pad1;
 	XcmsFloat pad2;
 	XcmsFloat pad3;
 } XcmsPad;		/\(** four doubles */
-.De
+.EE
 .SH DESCRIPTION
 The
 .ZN XcmsColor
@@ -271,5 +261,5 @@
 XcmsAllocColor(3X11),
 XcmsStoreColor(3X11),
 XcmsConvertColors(3X11),
-.br
+.LP
 \fI\*(xL\fP
Comment 1 Daniel Stone 2007-02-27 01:35:44 UTC
Sorry about the phenomenal bug spam, guys.  Adding xorg-team@ to the QA contact so bugs don't get lost in future.
Comment 2 Alan Coopersmith 2007-08-21 15:11:20 UTC
Fix committed to git master:
commit 2e7e0748d353d7f53bbd65ec6bf0df8758528ddc
Author: Eric S. Raymond <esr@thyrsus.com>
Date:   Sun Jan 14 10:39:00 2007 -0800

    Bug #9651: Bad markup in XcmsColor.3x
    
    X.Org Bugzilla #9651 <https://bugs.freedesktop.org/show_bug.cgi?id=9651>

Thanks for the patch!


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.