Bug 9654

Summary:	Bad markup in XrmGetFileDatabase.3x
Product:	xorg	Reporter:	Eric S. Raymond <esr>
Component:	Lib/other	Assignee:	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:02 UTC

Problems with XrmGetFileDatabase.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.

--- XrmGetFileDatabase.3x-orig	2007-01-14 02:46:07.000000000 -0500
+++ XrmGetFileDatabase.3x	2007-01-14 02:47:16.000000000 -0500
@@ -140,6 +140,16 @@
 .el .sp 10p
 ..
 .ny0
+.de EX
+.sp
+.nf
+.ft CW
+..
+.de EE
+.ft R
+.fi
+.sp
+..
 .TH XrmGetFileDatabase 3X11 "libX11 1.0.3" "X Version 11" "XLIB FUNCTIONS"
 .SH NAME
 XrmGetFileDatabase, XrmPutFileDatabase, XrmGetStringDatabase,
XrmLocaleOfDatabase, XrmGetDatabase, XrmSetDatabase, XrmDestroyDatabase \-
retrieve and store resource databases
@@ -247,9 +257,7 @@
 The syntax of an individual resource line is:
 .LP
 .\" Start marker code here
-.Ds 0
-.TA 1.5i 1.75i
-.ta 1.5i 1.75i
+.EX
 ResourceLine	=	Comment | IncludeFile | ResourceSpec | <empty line>
 Comment	=	"!" {<any character except null or newline>}
 IncludeFile	=	"#" WhiteSpace "include" WhiteSpace FileName WhiteSpace
@@ -262,8 +270,7 @@
 ComponentName	=	NameChar {NameChar}
 NameChar	=	"a"\-"z" | "A"\-"Z" | "0"\-"9" | "_" | "-"
 Value	=	{<any character except null or unescaped newline>}
-.De
-.\" End marker code here
+.EE
 .LP
 Elements separated by vertical bar (|) are alternatives.
 Curly braces ({\&.\&.\&.}) indicate zero or more repetitions

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:37:18 UTC

Thanks for the fix - patch committed to git master:

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

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

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.