From f107d40a9e91e0cd06635c29a51633339f0f7465 Mon Sep 17 00:00:00 2001
From: Matt Dew <marcoz@osource.org>
Date: Sun, 22 May 2011 19:34:50 -0600
Subject: Add olinks to functions decribed in libX11 documentation.

This patch is used with the libX11 patch.
It turns the functions listed in this doc into hyperlinks to the
declarations that are in libX11 documentation.

Signed-off-by: Matt Dew <marcoz@osource.org>
Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
---
 specs/bigreq.xml | 24 +++++++++++++++++++++---
 1 file changed, 21 insertions(+), 3 deletions(-)

(limited to 'specs')

diff --git a/specs/bigreq.xml b/specs/bigreq.xml
index c5b08b2..31281cb 100644
--- a/specs/bigreq.xml
+++ b/specs/bigreq.xml
@@ -287,9 +287,27 @@
 <chapter id='c_language_binding'>
 <title>C language binding</title>
 
-<para>It is desirable for core Xlib, and other extensions, to use this extension internally when necessary.  It is also desirable to make the use of this extension as transparent as possible to the X client.  For example, if enabling of the extension were delayed until the first time it was needed, an application that used <function>XNextRequest</function> to determine the sequence number of a request would no longer get the correct sequence number.  As such, <function>XOpenDisplay</function> will determine if the extension is supported by the server and, if it is, enable extended-length encodings.</para>
-
-<para>The core Xlib functions <function>XDrawLines</function>, <function>XDrawArcs</function>, <function>XFillPolygon</function>, <function>XChangeProperty</function>, <function>XSetClipRectangles</function>, and <function>XSetRegion</function> are required to use extended-length encodings when necessary, if supported by the server.  Use of extended-length encodings in other core Xlib functions (<function>XDrawPoints</function>, <function>XDrawRectangles</function>, <function>XDrawSegments</function>. <function>XFillArcs</function>, <function>XFillRectangles</function>, <function>XPutImage</function> is permitted but not required; an Xlib implementation may choose to split the data across multiple smaller requests instead.</para>
+<para>It is desirable for core Xlib, and other extensions, to use this extension internally when necessary.  It is also desirable to make the use of this extension as transparent as possible to the X client.  For example, if enabling of the extension were delayed until the first time it was needed, an application that used
+<olink targetdoc='libX11' targetptr='xnextrequest'><function>XNextRequest</function></olink>
+to determine the sequence number of a request would no longer get the correct sequence number.  As such,
+<olink targetdoc='libX11' targetptr='xopendisplay'><function>XOpenDisplay</function></olink>
+will determine if the extension is supported by the server and, if it is, enable extended-length encodings.</para>
+
+<para>The core Xlib functions
+<olink targetdoc='libX11' targetptr='xdrawlines'><function>XDrawLines</function></olink>,
+<olink targetdoc='libX11' targetptr='xdrawarcs'><function>XDrawArcs</function></olink>,
+<olink targetdoc='libX11' targetptr='xfillpolygon'><function>XFillPolygon</function></olink>,
+<olink targetdoc='libX11' targetptr='xchangeproperty'><function>XChangeProperty</function></olink>,
+<olink targetdoc='libX11' targetptr='xsetcliprectangles'><function>XSetClipRectangles</function></olink>, and
+<olink targetdoc='libX11' targetptr='xsetregion'><function>XSetRegion</function></olink>.
+are required to use extended-length encodings when necessary, if supported by the server.  Use of extended-length encodings in other core Xlib functions
+(<olink targetdoc='libX11' targetptr='xdrawpoints'><function>XDrawPoints</function></olink>,
+<olink targetdoc='libX11' targetptr='xdrawrectangles'><function>XDrawRectangles</function></olink>,
+<olink targetdoc='libX11' targetptr='xdrawsegments'><function>XDrawSegments</function></olink>.
+<olink targetdoc='libX11' targetptr='xfillarcs'><function>XFillArcs</function></olink>,
+<olink targetdoc='libX11' targetptr='xfillrectangles'><function>XFillRectangles</function></olink>,
+<olink targetdoc='libX11' targetptr='xputimage'><function>XPutImage</function></olink>
+is permitted but not required; an Xlib implementation may choose to split the data across multiple smaller requests instead.</para>
 
 <para>To permit clients to know what the maximum-request-length for extended-length encodings is, the following function is added to Xlib:
 
-- 
cgit v1.2.1