Bug 9655

Summary: Bad markup in XrmUniqueQuark.3x
Product: xorg Reporter: Eric S. Raymond <esr>
Component: Lib/otherAssignee: Xorg Project Team <xorg-team>
Status: RESOLVED FIXED QA Contact: Xorg Project Team <xorg-team>
Severity: normal    
Priority: high    
Version: unspecified   
Hardware: x86 (IA32)   
OS: Linux (All)   
Whiteboard:
i915 platform: i915 features:

Description Eric S. Raymond 2007-01-14 10:43:52 UTC
Problems with XrmUniqueQuark.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.

--- XrmUniqueQuark.3x-orig	2007-01-14 02:52:25.000000000 -0500
+++ XrmUniqueQuark.3x	2007-01-14 02:53:03.000000000 -0500
@@ -143,7 +143,7 @@
 .TH XrmUniqueQuark 3X11 "libX11 1.0.3" "X Version 11" "XLIB FUNCTIONS"
 .SH NAME
 XrmUniqueQuark, XrmStringToQuark, XrmPermStringToQuark, XrmQuarkToString,
XrmStringToQuarkList, XrmStringToBindingQuarkList \- manipulate resource quarks
-.SH SYNTAX
+.SH SYNOPSIS
 .HP
 XrmQuark XrmUniqueQuark\^(void); 
 .LP
@@ -267,9 +267,9 @@
 and indicates if components of name or class lists are bound tightly or loosely
 (that is, if wildcarding of intermediate components is specified).
 .LP
-.Ds 0
+.EX
 typedef enum {XrmBindTightly, XrmBindLoosely} XrmBinding, *XrmBindingList;
-.De
+.EE
 .LP
 .ZN XrmBindTightly
 indicates that a period separates the components, and
@@ -290,17 +290,15 @@
 a period is assumed.
 For example, ``*a.b*c'' becomes:
 .LP
-.Ds 0
-.TA .75i 1.5i 2.25i
-.ta .75i 1.5i 2.25i
+.TS
+l l l.
 quarks	a	b	c
-.br
 bindings	loose	tight	loose
-.De
+.TE
 .SH "SEE ALSO"
 XrmGetResource(3X11),
 XrmInitialize(3X11),
 XrmMergeDatabases(3X11),
 XrmPutResource(3X11)
-.br
+.LP
 \fI\*(xL\fP
Comment 1 Daniel Stone 2007-02-27 01:35:45 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:39:27 UTC
Thanks for the fix - patch committed to git master:

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

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

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.