Bug 9650 - Bad markup in XLoadFont.3x manual page
Summary: Bad markup in XLoadFont.3x manual page
Status: RESOLVED FIXED
Alias: None
Product: xorg
Classification: Unclassified
Component: Lib/Xft (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:38 UTC by Eric S. Raymond
Modified: 2007-08-21 15:34 UTC (History)
0 users

See Also:
i915 platform:
i915 features:


Attachments

Description Eric S. Raymond 2007-01-14 10:38:17 UTC
Problems with XLoadFont.3x:

1. Ambiguous or invalid backslash.  This doesn't cause groff a problem.
but it confuses doclifter and may confuse older troff implementations.

2. 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.
--- XLoadFont.3x-orig	2007-01-14 02:29:55.000000000 -0500
+++ XLoadFont.3x	2007-01-14 02:31:11.000000000 -0500
@@ -141,6 +141,16 @@
 .el .sp 10p
 ..
 .ny0
+.de EX
+.sp
+.nf
+.ft CW
+..
+.de EE
+.ft R
+.fi
+.sp
+..
 .TH XLoadFont 3X11 "libX11 1.0.3" "X Version 11" "XLIB FUNCTIONS"
 .SH NAME
 XLoadFont, XQueryFont, XLoadQueryFont, XFreeFont, XGetFontProperty,
XUnloadFont, XCharStruct, XFontProp, XChar2b, XFontStruct \- load or unload
fonts and font metric structures
@@ -309,9 +319,7 @@
 structures contain:
 .LP
 .IN "XCharStruct" "" "@DEF@"
-.Ds 0
-.TA .5i 3i
-.ta .5i 3i
+.EX
 typedef struct {
 	short lbearing;	/\(** origin to left edge of raster */
 	short rbearing;	/\(** origin to right edge of raster */
@@ -320,32 +328,26 @@
 	short descent;	/\(** baseline to bottom edge of raster */
 	unsigned short attributes;	/\(** per char flags (not predefined) */
 } XCharStruct;
-.De
+.EE
 .LP
 .IN "XFontProp" "" "@DEF@"
-.Ds 0
-.TA .5i 1i 3i
-.ta .5i 1i 3i
+.EX
 typedef struct {
 	Atom	name;
 	unsigned long card32;
 } XFontProp;
-.De
+.EE
 .LP
 .IN "XChar2b" "" "@DEF@"
-.Ds 0
-.TA .5i 3i
-.ta .5i 3i
+.EX
 typedef struct {	/\(** normal 16 bit characters are two bytes */
     unsigned char byte1;
     unsigned char byte2;
 } XChar2b;
-.De
+.EE
 .LP
 .IN "XFontStruct" "" "@DEF@"
-.Ds 0
-.TA .5i 3i
-.ta .5i 3i
+.EX
 typedef struct {
 	XExtData *ext_data;	/\(** hook for extension to hang data */
 	Font fid;	/\(** Font id for this font */
@@ -364,7 +366,7 @@
 	int ascent;	/\(** logical extent above baseline for spacing */
 	int descent;	/\(** logical decent below baseline for spacing */
 } XFontStruct;
-.De
+.EE
 .LP
 X supports single byte/character, two bytes/character matrix,
 and 16-bit character text operations.
@@ -416,19 +418,16 @@
 and the 2-byte character index values corresponding to the
 per_char array element N (counting from 0) are:
 .IP
-.nf
+.EX
 	byte1 = N/D + min_byte1
-.br
 	byte2 = N\\D + min_char_or_byte2
-.IP
-.fi
+.EE
 where:
-.IP
-.nf
+.EX
         D = max_char_or_byte2 \- min_char_or_byte2 + 1
         / = integer division
-        \\ = integer modulus
-.fi
+        \e\e = integer modulus
+.EE
 .IP \(bu 5
 If the per_char pointer is NULL, 
 all glyphs between the first and last character indexes
Comment 1 Daniel Stone 2007-02-27 01:35:43 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:34:00 UTC
Thanks for the patch - fix committed to git master:

commit c316aaf0aab06951db9dc5c9c1148bfea835d885
Author: Eric S. Raymond <esr@thyrsus.com>
Date:   Sun Jan 14 10:38:00 2007 -0800

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


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.