Bug 9427 - Problems in manual-page markup on the Mesa gl library pages
Summary: Problems in manual-page markup on the Mesa gl library pages
Status: RESOLVED WONTFIX
Alias: None
Product: Mesa
Classification: Unclassified
Component: Other (show other bugs)
Version: 9.2
Hardware: x86 (IA32) Linux (All)
: high major
Assignee: karan kapoor
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-12-22 11:13 UTC by Eric S. Raymond
Modified: 2016-08-31 21:21 UTC (History)
1 user (show)

See Also:
i915 platform:
i915 features:


Attachments
Libar (82.50 KB, application/msword)
2016-08-31 19:06 UTC, karan kapoor
Details

Description Eric S. Raymond 2006-12-22 11:13:24 UTC
Most of this bug report is a fix diff that removes instances of the macros ".TE"
and ".BP" from the gl library man pages.  These macros do nothing -- nothing,
that is, but screw up attempts to automatically lift the pages to a richer
XML-based format.

See http://catb.org/~esr/doclifter/problems.html for details on how and
why these patches were generated.  Feel free to email me with any questions.

Problems with glBegin.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glBegin.3gl-orig	2006-12-20 03:55:09.000000000 -0500
+++ glBegin.3gl	2006-12-20 03:55:46.000000000 -0500
@@ -79,7 +79,6 @@
 Treats each triplet of vertices as an independent triangle.
 Vertices $3n^-^2$, $3n^-^1$, and $3n$ define triangle $n$.
 $N/3$ triangles are drawn.
-.BP
 .TP
 \%\f3GL_TRIANGLE_STRIP\fP
 Draws a connected group of triangles.  One triangle is defined for each
-----------------------------
Problems with glBitmap.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glBitmap.3gl-orig	2006-12-20 03:59:17.000000000 -0500
+++ glBitmap.3gl	2006-12-20 03:59:31.000000000 -0500
@@ -66,7 +66,7 @@
 of that command,
 and with \f2type\fP set to \%\f3GL_BITMAP\fP
 and \f2format\fP set to \%\f3GL_COLOR_INDEX\fP.
-.BP
+.P
 Modes specified using \%\f3glPixelStore\fP affect the
 interpretation of bitmap image data;
 modes specified using \%\f3glPixelTransfer\fP do not.
-----------------------------
Problems with glBlendFunc.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glBlendFunc.3gl-orig	2006-12-20 04:05:28.000000000 -0500
+++ glBlendFunc.3gl	2006-12-20 04:06:14.000000000 -0500
@@ -39,8 +39,7 @@
 \%\f3GL_ONE_MINUS_DST_ALPHA\fP, and
 \%\f3GL_SRC_ALPHA_SATURATE\fP.
 The initial value is \%\f3GL_ONE\fP.
-.TE
-
+.P
 Additionally, if the \%\f3GL_ARB_imaging\fP extension is supported, the
 following constants are accepted:
 \%\f3GL_CONSTANT_COLOR\fP,
@@ -61,8 +60,7 @@
 \%\f3GL_DST_ALPHA\fP, and
 \%\f3GL_ONE_MINUS_DST_ALPHA\fP.
 The initial value is \%\f3GL_ZERO\fP.
-.TE
-
+.P
 Additionally, if the \%\f3GL_ARB_imaging\fP extension is supported, the
 following constants are accepted:
 \%\f3GL_CONSTANT_COLOR\fP,
-----------------------------
Problems with glCopyPixels.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glCopyPixels.3gl-orig	2006-12-20 04:06:49.000000000 -0500
+++ glCopyPixels.3gl	2006-12-20 04:07:10.000000000 -0500
@@ -209,7 +209,7 @@
 use
 .Ex
 glCopyPixels(0, 0, 1, 1, \%\f3GL_COLOR\fP);
-.En
+.Ee
 .SH NOTES
 Modes specified by \%\f3glPixelStore\fP have no effect on the operation
 of \%\f3glCopyPixels\fP.
-----------------------------
Problems with glDepthFunc.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glDepthFunc.3gl-orig	2006-12-20 04:07:29.000000000 -0500
+++ glDepthFunc.3gl	2006-12-20 04:07:39.000000000 -0500
@@ -69,7 +69,7 @@
 .P
 The initial value of \f2func\fP is \%\f3GL_LESS\fP.
 Initially, depth testing is disabled.
-.NOTES
+.SH NOTES
 Even if the depth buffer exists and the depth mask is non-zero, the
 depth buffer is not updated if the depth test is disabled. 
 .SH ERRORS
-----------------------------
Problems with glDrawBuffer.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glDrawBuffer.3gl-orig	2006-12-20 04:08:10.000000000 -0500
+++ glDrawBuffer.3gl	2006-12-20 04:08:29.000000000 -0500
@@ -83,7 +83,6 @@
 Only the front right and back right color buffers are written.
 If there is no back right color buffer,
 only the front right color buffer is written.
-.BP
 .TP
 \%\f3GL_FRONT_AND_BACK\fP
 All the front and back color buffers
-----------------------------
Problems with glDrawPixels.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glDrawPixels.3gl-orig	2006-12-20 04:09:46.000000000 -0500
+++ glDrawPixels.3gl	2006-12-20 04:10:22.000000000 -0500
@@ -180,7 +180,6 @@
 Whether the lookup replacement of the index is done or not,
 the integer part of the index is then ANDed with $2 sup b -1$,
 where $b$ is the number of bits in a color index buffer.
-.BP
 .IP
 The GL then converts the resulting indices or RGBA colors to fragments
 by attaching the current raster position \f2z\fP coordinate and
@@ -309,7 +308,6 @@
 \%\f3GL_PIXEL_MAP_c_TO_c\fP,
 then replaced by the value that it references in that table.
 \f2c\fP is R, G, B, or A respectively.
-.BP
 .IP
 The GL then converts the resulting RGBA colors to fragments
 by attaching the current raster position \f2z\fP coordinate and
@@ -368,7 +366,6 @@
 It is then converted to an RGBA pixel with red, green, and blue set to 0.
 After this conversion, the pixel is treated as if it had been read
 as an RGBA pixel.
-.BP
 .TP
 \%\f3GL_RGB\fP
 .TP
@@ -436,7 +433,6 @@
 _
 .TE
 .sp
-.BP
 .P
 The rasterization described so far assumes pixel zoom factors of 1.
 If 
-----------------------------
Problems with glEnableClientState.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glEnableClientState.3gl-orig	2006-12-20 04:11:10.000000000 -0500
+++ glEnableClientState.3gl	2006-12-20 04:11:23.000000000 -0500
@@ -19,7 +19,6 @@
 .nf
 .fi
 
-.EN
 .SH PARAMETERS
 .TP \w'\f21.1\fP\ \ 'u
 \f21.1\fP
-----------------------------
Problems with glGetString.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glGetString.3gl-orig	2006-12-20 04:11:44.000000000 -0500
+++ glGetString.3gl	2006-12-20 04:12:12.000000000 -0500
@@ -9,7 +9,7 @@
 .ds Xs 56397 5 getstring.gl
 .TH GLGETSTRING 3G
 .SH NAME
-.B "\- return a string describing the current GL connection
+.B glGetString \- return a string describing the current GL connection
 
 .SH C SPECIFICATION
 const GLubyte* \f3glGetString\fP(
-----------------------------
Problems with glGetTexGen.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glGetTexGen.3gl-orig	2006-12-20 04:12:34.000000000 -0500
+++ glGetTexGen.3gl	2006-12-20 04:12:48.000000000 -0500
@@ -78,7 +78,6 @@
 object linear-coordinate generation.
 Integer values, when requested,
 are mapped directly from the internal floating-point representation.
-.BP
 .TP
 \%\f3GL_EYE_PLANE\fP
 \f2params\fP returns the four plane equation coefficients that specify
-----------------------------
Problems with glGetTexImage.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glGetTexImage.3gl-orig	2006-12-20 04:13:00.000000000 -0500
+++ glGetTexImage.3gl	2006-12-20 04:13:10.000000000 -0500
@@ -101,7 +101,7 @@
 or to the height of the texture image
 (including border if one was specified)
 for 2D images.
-.BP
+.P
 Because the internal texture image is an RGBA image,
 pixel formats \%\f3GL_COLOR_INDEX\fP,
 \%\f3GL_STENCIL_INDEX\fP,
-----------------------------
Problems with glGetTexParameter.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glGetTexParameter.3gl-orig	2006-12-20 04:13:33.000000000 -0500
+++ glGetTexParameter.3gl	2006-12-20 04:13:43.000000000 -0500
@@ -97,7 +97,6 @@
 \%\f3GL_TEXTURE_WRAP_R\fP
 Returns the single-valued wrapping function for texture coordinate $r$,
 a symbolic constant. The initial value is \%\f3GL_REPEAT\fP.
-.BP
 .TP
 \%\f3GL_TEXTURE_BORDER_COLOR\fP
 Returns four integer or floating-point numbers that comprise the RGBA color
-----------------------------
Problems with glLight.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glLight.3gl-orig	2006-12-20 04:13:59.000000000 -0500
+++ glLight.3gl	2006-12-20 04:14:07.000000000 -0500
@@ -205,7 +205,7 @@
 If the angle between the direction of the light and the direction from the
 light to the vertex being lighted is greater than the spot cutoff angle,
 the light is completely masked.
-.BP
+.P
 Otherwise, its intensity is controlled by the spot exponent and the
 attenuation factors.
 The initial spot cutoff is 180,
-----------------------------
Problems with glMatrixMode.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glMatrixMode.3gl-orig	2006-12-20 04:14:21.000000000 -0500
+++ glMatrixMode.3gl	2006-12-20 04:14:34.000000000 -0500
@@ -28,8 +28,7 @@
 \%\f3GL_PROJECTION\fP, and
 \%\f3GL_TEXTURE\fP.
 The initial value is \%\f3GL_MODELVIEW\fP.
-.TE
-
+.P
 Additionally, if the \%\f3GL_ARB_imaging\fP extension is supported,
 \%\f3GL_COLOR\fP is also accepted.
 .SH DESCRIPTION
-----------------------------
Problems with glOrtho.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glOrtho.3gl-orig	2006-12-20 04:14:47.000000000 -0500
+++ glOrtho.3gl	2006-12-20 04:15:12.000000000 -0500
@@ -51,7 +51,6 @@
    ccol { {t sub x}~ above {t sub y}~ above {t sub z}~ above 1~ }
 } right )
 .EN
-.BP
 .P
 where
 .ce
-----------------------------
Problems with glPixelTransfer.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glPixelTransfer.3gl-orig	2006-12-20 04:15:39.000000000 -0500
+++ glPixelTransfer.3gl	2006-12-20 04:15:48.000000000 -0500
@@ -134,7 +134,6 @@
 Finally,
 \f2stencil\fP pixels comprise a single fixed-point value,
 with unspecified precision to the right of the binary point.
-.BP
 .P
 The pixel transfer operations performed on the four basic pixel types are 
 as follows:
-----------------------------
Problems with glRect.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glRect.3gl-orig	2006-12-20 04:16:35.000000000 -0500
+++ glRect.3gl	2006-12-20 04:16:43.000000000 -0500
@@ -79,7 +79,6 @@
 	const GLshort \fI*v2\fP )
 .fi
 
-.BP
 .SH PARAMETERS
 .TP
 \f2v1\fP
-----------------------------
Problems with glTexCoord.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glTexCoord.3gl-orig	2006-12-20 04:17:03.000000000 -0500
+++ glTexCoord.3gl	2006-12-20 04:17:10.000000000 -0500
@@ -206,7 +206,7 @@
 .br
 \%\f3glTexCoord2\fP sets them to
 (\f2s\fP, \f2t\fP, 0, 1).
-.BP
+.P
 Similarly, \%\f3glTexCoord3\fP specifies the texture coordinates as
 (\f2s\fP, \f2t\fP, \f2r\fP, 1), and
 \%\f3glTexCoord4\fP defines all four components explicitly as
-----------------------------
Problems with glTexEnv.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glTexEnv.3gl-orig	2006-12-20 04:17:24.000000000 -0500
+++ glTexEnv.3gl	2006-12-20 04:18:18.000000000 -0500
@@ -166,7 +166,7 @@
 When the \%\f3GL_ARB_multitexture\fP extension is supported, \%\f3glTexEnv\fP
controls 
 the texture environment for the current active texture unit, selected by 
 \%\f3glActiveTextureARB\fP.
-.sh ERRORS
+.SH ERRORS
 \%\f3GL_INVALID_ENUM\fP is generated when \f2target\fP or \f2pname\fP is not
 one of the accepted defined values,
 or when \f2params\fP should have a defined constant value
-----------------------------
Problems with glTexImage1D.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glTexImage1D.3gl-orig	2006-12-20 04:19:28.000000000 -0500
+++ glTexImage1D.3gl	2006-12-20 04:20:07.000000000 -0500
@@ -286,10 +286,10 @@
 and \%\f3GL_RGBA\fP must match exactly. The numeric values 1, 2, 3, and 4 may
also be used to 
 specify the preceding representations.)
 .P
-Use the \%\f3GL_PROXY_TEXTURE_1D\fP target to try out a resolution and
-. The implementation will
-update and recompute its best match for the requested storage resolution
-and . To query this state, call \%\f3glGetTexLevelParameter\fP.
+Use the \%\f3GL_PROXY_TEXTURE_1D\fP target to try out a resolution. 
+The implementation will
+update and recompute its best match for the requested storage resolution. 
+To query this state, call \%\f3glGetTexLevelParameter\fP.
 If the texture cannot be accommodated, texture state is set to 0.
 .P
 A one-component texture image uses only the red component of the RGBA
-----------------------------
Problems with glTexImage2D.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glTexImage2D.3gl-orig	2006-12-20 04:20:17.000000000 -0500
+++ glTexImage2D.3gl	2006-12-20 04:20:32.000000000 -0500
@@ -309,10 +309,10 @@
 and \%\f3GL_RGBA\fP must match exactly. The numeric values 1, 2, 3, and 4
 may also be used to specify the above representations.)
 .P
-Use the \%\f3GL_PROXY_TEXTURE_2D\fP target to try out a resolution and
-. The implementation will
-update and recompute its best match for the requested storage resolution
-and . To then query this state, call
+Use the \%\f3GL_PROXY_TEXTURE_2D\fP target to try out a resolution. 
+The implementation will
+update and recompute its best match for the requested storage resolution. 
+To then query this state, call
 \%\f3glGetTexLevelParameter\fP.
 If the texture cannot be accommodated, texture state is set to 0.
 .P
-----------------------------
Problems with glTexImage3D.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glTexImage3D.3gl-orig	2006-12-20 04:20:43.000000000 -0500
+++ glTexImage3D.3gl	2006-12-20 04:20:59.000000000 -0500
@@ -315,10 +315,10 @@
 and \%\f3GL_RGBA\fP must match exactly. The numeric values 1, 2, 3, and 4
 may also be used to specify the above representations.)
 .P
-Use the \%\f3GL_PROXY_TEXTURE_3D\fP target to try out a resolution and
-. The implementation will
-update and recompute its best match for the requested storage resolution
-and . To then query this state, call
+Use the \%\f3GL_PROXY_TEXTURE_3D\fP target to try out a resolution. 
+The implementation will
+update and recompute its best match for the requested storage resolution.
+To then query this state, call
 \%\f3glGetTexLevelParameter\fP.
 If the texture cannot be accommodated, texture state is set to 0.
 .P
-----------------------------
Problems with glXChooseVisual.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glXChooseVisual.3gl-orig	2006-12-20 04:21:20.000000000 -0500
+++ glXChooseVisual.3gl	2006-12-20 04:21:41.000000000 -0500
@@ -69,7 +69,6 @@
 color index buffer size.
 The smallest index buffer of at least the specified size is preferred.
 Ignored if \f3GLX_RGBA\fP is asserted.
-.BP
 .TP
 \f3GLX_LEVEL\fP
 Must be followed by an integer buffer-level specification.
@@ -175,7 +174,6 @@
 visuals with no alpha accumulation buffer are preferred.
 Otherwise, the largest possible alpha accumulation buffer
 of at least the minimum size is preferred.
-.TE
 .SH EXAMPLES
 .TP 12
 \f2attribList\fP =
-----------------------------
Problems with glXGetConfig.3gl:

1. Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

--- glXGetConfig.3gl-orig	2006-12-20 04:22:17.000000000 -0500
+++ glXGetConfig.3gl	2006-12-20 04:22:24.000000000 -0500
@@ -118,7 +118,6 @@
 .TP
 \f3GLX_ACCUM_ALPHA_SIZE\fP
 Number of bits of alpha stored in the accumulation buffer.
-.TE
 .P
 The X protocol allows a single visual ID to be instantiated with
 different numbers of bits per pixel.
-----------------------------
Comment 1 Ian Romanick 2009-09-17 16:42:18 UTC
Mesa no longer has its own copies of the OpenGL manual pages.  They are now available directly from OpenGL.org.
Comment 2 karan kapoor 2016-08-31 19:06:46 UTC
Created attachment 126146 [details]
Libar

.
Comment 3 Mark Janes 2016-08-31 19:36:01 UTC
Karan, please explain why you re-opened this bug.
Comment 4 Emil Velikov 2016-08-31 21:21:23 UTC
While nothing of note is detected [1] one could abuse the OLE2 object(s) for malicious purposes, even on Libre/OpenOffice. Also the file contains some seemingly spam links.

End of PSA ;-)

[1] https://www.virustotal.com/en/file/5a2fdbfad5e5197404be47c3a5b4f64e5db15059ae266e2410428a3f9de14987/analysis/1472678004/


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.