[PATCH: libX11 1/2] Add id attributes to error codes to allow linking from other docs.

Gaetan Nadon memsize at videotron.ca
Tue Jul 5 14:09:47 PDT 2011


On Fri, 2011-07-01 at 13:11 -0600, Matt Dew wrote:

> Signed-off-by: Matt Dew <marcoz at osource.org>
> ---
>  specs/libX11/CH11.xml |   34 +++++++++++++++++-----------------
>  1 files changed, 17 insertions(+), 17 deletions(-)
> 
> diff --git a/specs/libX11/CH11.xml b/specs/libX11/CH11.xml
> index 3fe6f23..71ba3a7 100644
> --- a/specs/libX11/CH11.xml
> +++ b/specs/libX11/CH11.xml
> @@ -2061,7 +2061,7 @@ chapter:
>    </thead>
>    <tbody>
>      <row>
> -      <entry><errorname>BadAccess</errorname></entry>
> +      <entry><errorname id='badaccess'>BadAccess</errorname></entry>
>        <entry>A client attempts to grab a key/button combination already grabbed
>        by another client.</entry>
>      </row>
> @@ -2085,7 +2085,7 @@ chapter:
>        has already selected.</entry>
>      </row>
>      <row>
> -      <entry><errorname>BadAlloc</errorname></entry>
> +      <entry><errorname id='badalloc'>BadAlloc</errorname></entry>
>        <entry>The server fails to allocate the requested resource.
>        Note that the explicit listing of
>        <errorname>BadAlloc</errorname>
> @@ -2100,42 +2100,42 @@ chapter:
>        them.</entry>
>      </row>
>      <row>
> -      <entry><errorname>BadAtom</errorname></entry>
> +      <entry><errorname id='badatom'>BadAtom</errorname></entry>
>        <entry>A value for an atom argument does not name a defined atom.</entry>
>      </row>
>      <row>
> -      <entry><errorname>BadColor</errorname></entry>
> +      <entry><errorname id='badcolor'>BadColor</errorname></entry>
>        <entry>A value for a colormap argument does not name a defined colormap.</entry>
>      </row>
>      <row>
> -      <entry><errorname>BadCursor</errorname></entry>
> +      <entry><errorname id='badcursor'>BadCursor</errorname></entry>
>        <entry>A value for a cursor argument does not name a defined cursor.</entry>
>      </row>
>      <row>
> -      <entry><errorname>BadDrawable</errorname></entry>
> +      <entry><errorname id='baddrawable'>BadDrawable</errorname></entry>
>        <entry>A value for a drawable argument does not name a defined window or pixmap.</entry>
>      </row>
>      <row>
> -      <entry><errorname>BadFont</errorname></entry>
> +      <entry><errorname id='badfont'>BadFont</errorname></entry>
>        <entry>A value for a font argument does not name a defined font (or, in some cases,
>        <type>GContext</type>).</entry>
>      </row>
>      <row>
> -      <entry><errorname>BadGC</errorname></entry>
> +      <entry><errorname id='badgc'>BadGC</errorname></entry>
>        <entry>A value for a
>        <type>GContext</type>
>        argument does not name a defined 
>        <type>GContext</type>.</entry>
>      </row>
>      <row>
> -      <entry><errorname>BadIDChoice</errorname></entry>
> +      <entry><errorname id='badidchoice'>BadIDChoice</errorname></entry>
>        <entry>The value chosen for a resource identifier either is not included in the
>        range assigned to the client or is already in use.
>        Under normal circumstances,
>        this cannot occur and should be considered a server or Xlib error.</entry>
>      </row>
>      <row>
> -      <entry><errorname>BadImplementation</errorname></entry>
> +      <entry><errorname id='badimplementation'>BadImplementation</errorname></entry>
>        <entry>The server does not implement some aspect of the request.
>        A server that generates this error for a core request is deficient.
>        As such, this error is not listed for any of the requests,
> @@ -2143,7 +2143,7 @@ chapter:
>        and handle or discard them.</entry>
>      </row>
>      <row>
> -      <entry><errorname>BadLength</errorname></entry>
> +      <entry><errorname id='badlength'>BadLength</errorname></entry>
>        <entry>The length of a request is shorter or longer than that required to
>        contain the arguments.
>        This is an internal Xlib or server error.</entry>
> @@ -2154,7 +2154,7 @@ chapter:
>        The length of a request exceeds the maximum length accepted by the server.</entry>
>      </row>
>      <row>
> -      <entry><errorname>BadMatch</errorname></entry>
> +      <entry><errorname id='badmatch'>BadMatch</errorname></entry>
>        <entry>In a graphics request,
>        the root and depth of the graphics context do not match those of the drawable.</entry>
>      </row>
> @@ -2174,20 +2174,20 @@ chapter:
>        window lacks this attribute.</entry>
>      </row>
>      <row>
> -      <entry><errorname>BadName</errorname></entry>
> +      <entry><errorname id='badname'>BadName</errorname></entry>
>        <entry>A font or color of the specified name does not exist.</entry>
>      </row>
>      <row>
> -      <entry><errorname>BadPixmap</errorname></entry>
> +      <entry><errorname id='badpixmap'>BadPixmap</errorname></entry>
>        <entry>A value for a pixmap argument does not name a defined pixmap.</entry>
>      </row>
>      <row>
> -      <entry><errorname>BadRequest</errorname></entry>
> +      <entry><errorname id='badrequest'>BadRequest</errorname></entry>
>        <entry>The major or minor opcode does not specify a valid request.
>        This usually is an Xlib or server error.</entry>
>      </row>
>      <row>
> -      <entry><errorname>BadValue</errorname></entry>
> +      <entry><errorname id='badvalue'>BadValue</errorname></entry>
>        <entry>Some numeric value falls outside of the range of values accepted
>        by the request.
>        Unless a specific range is specified for an argument,
> @@ -2196,7 +2196,7 @@ chapter:
>        this error (due to the encoding).</entry>
>      </row>
>      <row>
> -      <entry><errorname>BadWindow</errorname></entry>
> +      <entry><errorname id='badwindow'>BadWindow</errorname></entry>
>        <entry>A value for a window argument does not name a defined window.</entry>
>      </row>
>    </tbody>


These are cases where a developer would have to make extra efforts to
write all lower case. I would prefer a string identical to the error
code.

Acked-by: Gaetan Nadon <memsize at videotron.ca>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.x.org/archives/xorg-devel/attachments/20110705/ac7af4a5/attachment.htm>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: This is a digitally signed message part
URL: <http://lists.x.org/archives/xorg-devel/attachments/20110705/ac7af4a5/attachment.pgp>


More information about the xorg-devel mailing list