diff options
author | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2010-10-31 09:38:21 +0000 |
---|---|---|
committer | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2010-10-31 09:38:21 +0000 |
commit | c93bcf9c4b017efb0cd75b329a6879285370cd83 (patch) | |
tree | 09225a16b05c4833a847495ce011a05e4e17f701 /proto/bigreqsproto | |
parent | b4bfb73038e20419fa7ee4ddf197449343a1dcdd (diff) |
Update to bigreqsproto 1.1.1. no functionnal change.
Diffstat (limited to 'proto/bigreqsproto')
-rw-r--r-- | proto/bigreqsproto/ChangeLog | 113 | ||||
-rw-r--r-- | proto/bigreqsproto/INSTALL | 291 | ||||
-rw-r--r-- | proto/bigreqsproto/Makefile.am | 13 | ||||
-rw-r--r-- | proto/bigreqsproto/README | 30 | ||||
-rw-r--r-- | proto/bigreqsproto/configure.ac | 21 | ||||
-rw-r--r-- | proto/bigreqsproto/specs/Makefile.am | 64 | ||||
-rw-r--r-- | proto/bigreqsproto/specs/bigreq.xml | 311 |
7 files changed, 831 insertions, 12 deletions
diff --git a/proto/bigreqsproto/ChangeLog b/proto/bigreqsproto/ChangeLog index b020680e3..6a2f8d633 100644 --- a/proto/bigreqsproto/ChangeLog +++ b/proto/bigreqsproto/ChangeLog @@ -1,3 +1,116 @@ +commit 59730aba859c0b586b7e63e79c07b7741719845d +Author: Alan Coopersmith <alan.coopersmith@oracle.com> +Date: Fri Oct 29 20:21:07 2010 -0700 + + bigreqsproto 1.1.1 + + Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com> + +commit f7f5f73576dbfeba63be400d16ec9e815962fea7 +Author: Alan Coopersmith <alan.coopersmith@oracle.com> +Date: Fri Oct 29 20:19:29 2010 -0700 + + Cleanup bigreq.xml a bit + + Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com> + +commit 3145dbb0c713a24e58f642a2acdafb5b1f63d948 +Author: Matt Dew <matt@osource.org> +Date: Mon Jun 28 08:09:05 2010 -0400 + + specs: convert bigreq.ms from xorg-docs module to DocBook XML + + Signed-off-by: Gaetan Nadon <memsize@videotron.ca> + +commit 18e93e57afeed6ea9872e7aab90da47f334690e1 +Author: Gaetan Nadon <memsize@videotron.ca> +Date: Sun Mar 28 19:25:52 2010 -0400 + + config: update AC_PREREQ statement to 2.60 + + Unrelated to the previous patches, the new value simply reflects + the reality that the minimum level for autoconf to configure + all x.org modules is 2.60 dated June 2006. + + ftp://ftp.gnu.org/gnu/autoconf/autoconf-2.60.tar.gz + + Signed-off-by: Gaetan Nadon <memsize@videotron.ca> + +commit b77888df9f01a9332d3cd15c413e5caa7fa18d80 +Author: Gaetan Nadon <memsize@videotron.ca> +Date: Sun Mar 28 19:00:30 2010 -0400 + + config: remove the pkgconfig pc.in file from EXTRA_DIST + + Automake always includes it in the tarball. + + Signed-off-by: Gaetan Nadon <memsize@videotron.ca> + +commit 1c9119c86437a58df4890b5ebf79bfdab40f0997 +Author: Gaetan Nadon <memsize@videotron.ca> +Date: Sun Nov 22 19:24:47 2009 -0500 + + Makefile.am: add ChangeLog and INSTALL on MAINTAINERCLEANFILES + + Now that the INSTALL file is generated. + Allows running make maintainer-clean. + +commit c3e90c94335ee9f835ec2546782547f0aaa46934 +Author: Gaetan Nadon <memsize@videotron.ca> +Date: Mon Nov 16 11:13:29 2009 -0500 + + README: file created or updated #24206 + + Contains a set of URLs to freedesktop.org. + +commit 104cb17755f7529a8f4410abad84398c0a4fd839 +Author: Gaetan Nadon <memsize@videotron.ca> +Date: Sun Nov 15 19:45:26 2009 -0500 + + Makefile.am: ChangeLog not required: EXTRA_DIST or *CLEANFILES #24432 + + ChangeLog filename is known to Automake and requires no further + coding in the makefile. + +commit 862e353a49eaa17dd60882b5941d4beff969860c +Author: Gaetan Nadon <memsize@videotron.ca> +Date: Sun Nov 15 18:31:28 2009 -0500 + + Makefile.am: INSTALL file is missing or incorrect #24206 + + The standard GNU file on building/installing tarball is copied + using the XORG_INSTALL macro contained in XORG_DEFAULT_OPTIONS + Add INSTALL target + +commit 07c29532215f8a210aa871fde3c8f5907f325ca2 +Author: Gaetan Nadon <memsize@videotron.ca> +Date: Sun Nov 15 18:11:36 2009 -0500 + + configure.ac: deploy the new XORG_DEFAULT_OPTIONS #24242 + + This macro aggregate a number of existing macros that sets commmon + X.Org components configuration options. It shields the configuration file from + future changes. + +commit fb8a4e291007c3cc25f3dda7a9e69bb6f1a8cc15 +Author: Gaetan Nadon <memsize@videotron.ca> +Date: Sun Nov 15 13:55:24 2009 -0500 + + configure.ac: AM_MAINTAINER_MODE missing #24238 + + This turns off maintainer mode build rules in tarballs. + Works in conjunction with autogen.sh --enable-maintainer-mode + +commit c242da1467928c1e43b2ae0b12876aa4487aac23 +Author: Gaetan Nadon <memsize@videotron.ca> +Date: Sat Nov 14 18:26:46 2009 -0500 + + .gitignore: use common defaults with custom section # 24239 + + Using common defaults will reduce errors and maintenance. + Only the very small or inexistent custom section need periodic maintenance + when the structure of the component changes. Do not edit defaults. + commit e19e245ff8e5ddedbcc5853786ca55b56f8ab40c Author: Peter Hutterer <peter.hutterer@who-t.net> Date: Tue Aug 11 10:28:21 2009 +1000 diff --git a/proto/bigreqsproto/INSTALL b/proto/bigreqsproto/INSTALL new file mode 100644 index 000000000..8b82ade08 --- /dev/null +++ b/proto/bigreqsproto/INSTALL @@ -0,0 +1,291 @@ +Installation Instructions +************************* + +Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, +2006, 2007, 2008 Free Software Foundation, Inc. + + This file is free documentation; the Free Software Foundation gives +unlimited permission to copy, distribute and modify it. + +Basic Installation +================== + + Briefly, the shell commands `./configure; make; make install' should +configure, build, and install this package. The following +more-detailed instructions are generic; see the `README' file for +instructions specific to this package. + + The `configure' shell script attempts to guess correct values for +various system-dependent variables used during compilation. It uses +those values to create a `Makefile' in each directory of the package. +It may also create one or more `.h' files containing system-dependent +definitions. Finally, it creates a shell script `config.status' that +you can run in the future to recreate the current configuration, and a +file `config.log' containing compiler output (useful mainly for +debugging `configure'). + + It can also use an optional file (typically called `config.cache' +and enabled with `--cache-file=config.cache' or simply `-C') that saves +the results of its tests to speed up reconfiguring. Caching is +disabled by default to prevent problems with accidental use of stale +cache files. + + If you need to do unusual things to compile the package, please try +to figure out how `configure' could check whether to do them, and mail +diffs or instructions to the address given in the `README' so they can +be considered for the next release. If you are using the cache, and at +some point `config.cache' contains results you don't want to keep, you +may remove or edit it. + + The file `configure.ac' (or `configure.in') is used to create +`configure' by a program called `autoconf'. You need `configure.ac' if +you want to change it or regenerate `configure' using a newer version +of `autoconf'. + +The simplest way to compile this package is: + + 1. `cd' to the directory containing the package's source code and type + `./configure' to configure the package for your system. + + Running `configure' might take a while. While running, it prints + some messages telling which features it is checking for. + + 2. Type `make' to compile the package. + + 3. Optionally, type `make check' to run any self-tests that come with + the package. + + 4. Type `make install' to install the programs and any data files and + documentation. + + 5. You can remove the program binaries and object files from the + source code directory by typing `make clean'. To also remove the + files that `configure' created (so you can compile the package for + a different kind of computer), type `make distclean'. There is + also a `make maintainer-clean' target, but that is intended mainly + for the package's developers. If you use it, you may have to get + all sorts of other programs in order to regenerate files that came + with the distribution. + + 6. Often, you can also type `make uninstall' to remove the installed + files again. + +Compilers and Options +===================== + + Some systems require unusual options for compilation or linking that +the `configure' script does not know about. Run `./configure --help' +for details on some of the pertinent environment variables. + + You can give `configure' initial values for configuration parameters +by setting variables in the command line or in the environment. Here +is an example: + + ./configure CC=c99 CFLAGS=-g LIBS=-lposix + + *Note Defining Variables::, for more details. + +Compiling For Multiple Architectures +==================================== + + You can compile the package for more than one kind of computer at the +same time, by placing the object files for each architecture in their +own directory. To do this, you can use GNU `make'. `cd' to the +directory where you want the object files and executables to go and run +the `configure' script. `configure' automatically checks for the +source code in the directory that `configure' is in and in `..'. + + With a non-GNU `make', it is safer to compile the package for one +architecture at a time in the source code directory. After you have +installed the package for one architecture, use `make distclean' before +reconfiguring for another architecture. + + On MacOS X 10.5 and later systems, you can create libraries and +executables that work on multiple system types--known as "fat" or +"universal" binaries--by specifying multiple `-arch' options to the +compiler but only a single `-arch' option to the preprocessor. Like +this: + + ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ + CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ + CPP="gcc -E" CXXCPP="g++ -E" + + This is not guaranteed to produce working output in all cases, you +may have to build one architecture at a time and combine the results +using the `lipo' tool if you have problems. + +Installation Names +================== + + By default, `make install' installs the package's commands under +`/usr/local/bin', include files under `/usr/local/include', etc. You +can specify an installation prefix other than `/usr/local' by giving +`configure' the option `--prefix=PREFIX'. + + You can specify separate installation prefixes for +architecture-specific files and architecture-independent files. If you +pass the option `--exec-prefix=PREFIX' to `configure', the package uses +PREFIX as the prefix for installing programs and libraries. +Documentation and other data files still use the regular prefix. + + In addition, if you use an unusual directory layout you can give +options like `--bindir=DIR' to specify different values for particular +kinds of files. Run `configure --help' for a list of the directories +you can set and what kinds of files go in them. + + If the package supports it, you can cause programs to be installed +with an extra prefix or suffix on their names by giving `configure' the +option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. + +Optional Features +================= + + Some packages pay attention to `--enable-FEATURE' options to +`configure', where FEATURE indicates an optional part of the package. +They may also pay attention to `--with-PACKAGE' options, where PACKAGE +is something like `gnu-as' or `x' (for the X Window System). The +`README' should mention any `--enable-' and `--with-' options that the +package recognizes. + + For packages that use the X Window System, `configure' can usually +find the X include and library files automatically, but if it doesn't, +you can use the `configure' options `--x-includes=DIR' and +`--x-libraries=DIR' to specify their locations. + +Particular systems +================== + + On HP-UX, the default C compiler is not ANSI C compatible. If GNU +CC is not installed, it is recommended to use the following options in +order to use an ANSI C compiler: + + ./configure CC="cc -Ae" + +and if that doesn't work, install pre-built binaries of GCC for HP-UX. + + On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot +parse its `<wchar.h>' header file. The option `-nodtk' can be used as +a workaround. If GNU CC is not installed, it is therefore recommended +to try + + ./configure CC="cc" + +and if that doesn't work, try + + ./configure CC="cc -nodtk" + +Specifying the System Type +========================== + + There may be some features `configure' cannot figure out +automatically, but needs to determine by the type of machine the package +will run on. Usually, assuming the package is built to be run on the +_same_ architectures, `configure' can figure that out, but if it prints +a message saying it cannot guess the machine type, give it the +`--build=TYPE' option. TYPE can either be a short name for the system +type, such as `sun4', or a canonical name which has the form: + + CPU-COMPANY-SYSTEM + +where SYSTEM can have one of these forms: + + OS KERNEL-OS + + See the file `config.sub' for the possible values of each field. If +`config.sub' isn't included in this package, then this package doesn't +need to know the machine type. + + If you are _building_ compiler tools for cross-compiling, you should +use the option `--target=TYPE' to select the type of system they will +produce code for. + + If you want to _use_ a cross compiler, that generates code for a +platform different from the build platform, you should specify the +"host" platform (i.e., that on which the generated programs will +eventually be run) with `--host=TYPE'. + +Sharing Defaults +================ + + If you want to set default values for `configure' scripts to share, +you can create a site shell script called `config.site' that gives +default values for variables like `CC', `cache_file', and `prefix'. +`configure' looks for `PREFIX/share/config.site' if it exists, then +`PREFIX/etc/config.site' if it exists. Or, you can set the +`CONFIG_SITE' environment variable to the location of the site script. +A warning: not all `configure' scripts look for a site script. + +Defining Variables +================== + + Variables not defined in a site shell script can be set in the +environment passed to `configure'. However, some packages may run +configure again during the build, and the customized values of these +variables may be lost. In order to avoid this problem, you should set +them in the `configure' command line, using `VAR=value'. For example: + + ./configure CC=/usr/local2/bin/gcc + +causes the specified `gcc' to be used as the C compiler (unless it is +overridden in the site shell script). + +Unfortunately, this technique does not work for `CONFIG_SHELL' due to +an Autoconf bug. Until the bug is fixed you can use this workaround: + + CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash + +`configure' Invocation +====================== + + `configure' recognizes the following options to control how it +operates. + +`--help' +`-h' + Print a summary of all of the options to `configure', and exit. + +`--help=short' +`--help=recursive' + Print a summary of the options unique to this package's + `configure', and exit. The `short' variant lists options used + only in the top level, while the `recursive' variant lists options + also present in any nested packages. + +`--version' +`-V' + Print the version of Autoconf used to generate the `configure' + script, and exit. + +`--cache-file=FILE' + Enable the cache: use and save the results of the tests in FILE, + traditionally `config.cache'. FILE defaults to `/dev/null' to + disable caching. + +`--config-cache' +`-C' + Alias for `--cache-file=config.cache'. + +`--quiet' +`--silent' +`-q' + Do not print messages saying which checks are being made. To + suppress all normal output, redirect it to `/dev/null' (any error + messages will still be shown). + +`--srcdir=DIR' + Look for the package's source code in directory DIR. Usually + `configure' can determine that directory automatically. + +`--prefix=DIR' + Use DIR as the installation prefix. *Note Installation Names:: + for more details, including other options available for fine-tuning + the installation locations. + +`--no-create' +`-n' + Run the configure checks, but stop before creating any output + files. + +`configure' also accepts some other, not widely useful, options. Run +`configure --help' for more details. + diff --git a/proto/bigreqsproto/Makefile.am b/proto/bigreqsproto/Makefile.am index d748fcb25..d39cc1ef9 100644 --- a/proto/bigreqsproto/Makefile.am +++ b/proto/bigreqsproto/Makefile.am @@ -1,3 +1,5 @@ +SUBDIRS=specs + bigreqsdir = $(includedir)/X11/extensions bigreqs_HEADERS = \ bigreqsproto.h \ @@ -6,14 +8,15 @@ bigreqs_HEADERS = \ pkgconfigdir = $(libdir)/pkgconfig pkgconfig_DATA = bigreqsproto.pc -EXTRA_DIST = bigreqsproto.pc.in -EXTRA_DIST += ChangeLog -MAINTAINERCLEANFILES = ChangeLog +MAINTAINERCLEANFILES = ChangeLog INSTALL + +.PHONY: ChangeLog INSTALL -.PHONY: ChangeLog +INSTALL: + $(INSTALL_CMD) ChangeLog: $(CHANGELOG_CMD) -dist-hook: ChangeLog +dist-hook: ChangeLog INSTALL diff --git a/proto/bigreqsproto/README b/proto/bigreqsproto/README new file mode 100644 index 000000000..f8b14de27 --- /dev/null +++ b/proto/bigreqsproto/README @@ -0,0 +1,30 @@ + Big Requests Extension + +This extension defines a protocol to enable the use of requests +that exceed 262140 bytes in length. + +Extension name: BIG-REQUESTS + +All questions regarding this software should be directed at the +Xorg mailing list: + + http://lists.freedesktop.org/mailman/listinfo/xorg + +Please submit bug reports to the Xorg bugzilla: + + https://bugs.freedesktop.org/enter_bug.cgi?product=xorg + +The master development code repository can be found at: + + git://anongit.freedesktop.org/git/xorg/proto/bigreqsproto + + http://cgit.freedesktop.org/xorg/proto/bigreqsproto + +For patch submission instructions, see: + + http://www.x.org/wiki/Development/Documentation/SubmittingPatches + +For more information on the git code manager, see: + + http://wiki.x.org/wiki/GitPage + diff --git a/proto/bigreqsproto/configure.ac b/proto/bigreqsproto/configure.ac index 8ecc2297c..2a0765f1f 100644 --- a/proto/bigreqsproto/configure.ac +++ b/proto/bigreqsproto/configure.ac @@ -1,12 +1,19 @@ -AC_PREREQ([2.57]) -AC_INIT([BigReqsProto], [1.1.0], [https://bugs.freedesktop.org/enter_bug.cgi?product=xorg]) +AC_PREREQ([2.60]) +AC_INIT([BigReqsProto], [1.1.1], + [https://bugs.freedesktop.org/enter_bug.cgi?product=xorg]) AM_INIT_AUTOMAKE([foreign dist-bzip2]) +AM_MAINTAINER_MODE -# Require xorg-macros: XORG_CHANGELOG -m4_ifndef([XORG_MACROS_VERSION], [AC_FATAL([must install xorg-macros 1.2 or later before running autoconf/autogen])]) -XORG_MACROS_VERSION(1.2) -XORG_RELEASE_VERSION -XORG_CHANGELOG +# Require xorg-macros minimum of 1.10 for DocBook XML documentation +m4_ifndef([XORG_MACROS_VERSION], + [m4_fatal([must install xorg-macros 1.10 or later before running autoconf/autogen])]) +XORG_MACROS_VERSION(1.10) +XORG_DEFAULT_OPTIONS +XORG_ENABLE_SPECS +XORG_WITH_XMLTO(0.0.20) +XORG_WITH_FOP +XORG_CHECK_SGML_DOCTOOLS(1.5) AC_OUTPUT([Makefile + specs/Makefile bigreqsproto.pc]) diff --git a/proto/bigreqsproto/specs/Makefile.am b/proto/bigreqsproto/specs/Makefile.am new file mode 100644 index 000000000..c1819a7c4 --- /dev/null +++ b/proto/bigreqsproto/specs/Makefile.am @@ -0,0 +1,64 @@ +# +# Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved. +# +# Permission is hereby granted, free of charge, to any person obtaining a +# copy of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice (including the next +# paragraph) shall be included in all copies or substantial portions of the +# Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +# DEALINGS IN THE SOFTWARE. +# + +if ENABLE_SPECS +doc_sources = bigreq.xml +dist_doc_DATA = $(doc_sources) + +if HAVE_XMLTO +doc_DATA = $(doc_sources:.xml=.html) + +if HAVE_FOP +doc_DATA += $(doc_sources:.xml=.ps) $(doc_sources:.xml=.pdf) +endif + +if HAVE_XMLTO_TEXT +doc_DATA += $(doc_sources:.xml=.txt) +endif + +if HAVE_STYLESHEETS +XMLTO_FLAGS = -m $(XSL_STYLESHEET) + +doc_DATA += xorg.css +xorg.css: $(STYLESHEET_SRCDIR)/xorg.css + $(AM_V_GEN)cp -pf $(STYLESHEET_SRCDIR)/xorg.css $@ +endif + +CLEANFILES = $(doc_DATA) + +SUFFIXES = .xml .ps .pdf .txt .html + +.xml.txt: + $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) txt $< + +.xml.html: + $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) xhtml-nochunks $< + +.xml.pdf: + $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) --with-fop pdf $< + +.xml.ps: + $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) --with-fop ps $< + +endif HAVE_XMLTO +endif ENABLE_SPECS diff --git a/proto/bigreqsproto/specs/bigreq.xml b/proto/bigreqsproto/specs/bigreq.xml new file mode 100644 index 000000000..5655bab72 --- /dev/null +++ b/proto/bigreqsproto/specs/bigreq.xml @@ -0,0 +1,311 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> + +<!-- lifted from troff+ms+XMan by doclifter --> +<book id="bigreqms"> + +<bookinfo> + <title>Big Requests Extension</title> + <subtitle>X Consortium Standard</subtitle> + <releaseinfo>X Version 11, Release 6.4</releaseinfo> + <authorgroup> + <author> + <firstname>Bob</firstname><surname>Scheifler</surname> + </author> + </authorgroup> + <corpname>X Consortium Standard</corpname> + <copyright><year>1993</year><year>1994</year> + <holder>X Consortium</holder></copyright> + <releaseinfo>Version 2.0</releaseinfo> + <affiliation><orgname>X Consortium</orgname></affiliation> + <productnumber>X Version 11, Release 7</productnumber> + +<legalnotice> +<para>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</para> + +<para>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</para> + +<para>THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</para> + +<para>Except as contained in this notice, the name of the X Consortium shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the X Consortium.</para> + +<para>X Window System is a trademark of The Open Group.</para> +</legalnotice> + +</bookinfo> + +<chapter id='overview'> +<title>Overview</title> + +<para>This extension enables the use of protocol requests that exceed 262140 bytes in length.</para> + +<para>The core protocol restricts the maximum length of a protocol request to 262140 bytes, in that it uses a 16-bit length field specifying the number of 4-byte units in the request. This is a problem in the core protocol when joining large numbers of lines (<symbol role='Pn'>PolyLine</symbol>) or arcs (<symbol role='Pn'>PolyArc</symbol>), since these requests cannot be broken up into smaller requests without disturbing the rendering of the join points. It is also much more of a problem for protocol extensions, such as the PEX extension for 3D graphics and the XIE extension for imaging, that need to send long data lists in output commands.</para> + +<para>This extension defines a mechanism for extending the length field beyond 16 bits. If the normal 16-bit length field of the protocol request is zero, then an additional 32-bit field containing the actual length (in 4-byte units) is inserted into the request, immediately following the 16-bit length field.</para> + +<para>For example, a normal <function>PolyLine</function> encoding is:</para> + +<informaltable pgwide='0' frame='none'> + <tgroup cols='4' align='left'> + <colspec colwidth='0.5in' colname='c1'/> + <colspec colwidth='1.5in' colname='c2'/> + <colspec colwidth='1.5in' colname='c3'/> + <colspec colwidth='2.0in' colname='c4'/> + <thead> + <row> + <entry namest="c1" nameend="c4"><function>PolyLine</function></entry> + </row> + </thead> + <tbody> + <row> + <entry>1</entry> + <entry>65</entry> + <entry></entry> + <entry>opcode</entry> + </row> + <row> + <entry>1</entry> + <entry></entry> + <entry></entry> + <entry>coordinate-mode</entry> + </row> + <row> + <entry></entry> + <entry>0</entry> + <entry>Origin</entry> + <entry></entry> + </row> + <row> + <entry></entry> + <entry>1</entry> + <entry>Previous</entry> + <entry></entry> + </row> + <row> + <entry>2</entry> + <entry>3+n</entry> + <entry></entry> + <entry></entry> + </row> + <row> + <entry>4</entry> + <entry>DRAWABLE</entry> + <entry></entry> + <entry>drawable</entry> + </row> + <row> + <entry>4</entry> + <entry>GCONTEXT</entry> + <entry></entry> + <entry>gc</entry> + </row> + <row> + <entry>4n</entry> + <entry>LISTofPOINT</entry> + <entry></entry> + <entry>points</entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para>An extended-length <function>PolyLine</function> encoding is:</para> + +<informaltable pgwide='0' frame='none'> + <tgroup cols='4' align='left'> + <colspec colwidth='0.5in' colname='c1'/> + <colspec colwidth='1.5in' colname='c2'/> + <colspec colwidth='1.5in' colname='c3'/> + <colspec colwidth='2.0in' colname='c4'/> + <thead> + <row> + <entry namest="c1" nameend="c4"><function>PolyLine</function></entry> + </row> + </thead> + <tbody> + <row> + <entry>1</entry> + <entry>65</entry> + <entry></entry> + <entry>opcode</entry> + </row> + <row> + <entry>1</entry> + <entry></entry> + <entry></entry> + <entry>coordinate-mode</entry> + </row> + <row> + <entry></entry> + <entry>0</entry> + <entry>Origin</entry> + <entry></entry> + </row> + <row> + <entry></entry> + <entry>1</entry> + <entry>Previous</entry> + <entry></entry> + </row> + <row> + <entry>2</entry> + <entry>0</entry> + <entry></entry> + <entry>extended length flag</entry> + </row> + <row> + <entry>4</entry> + <entry>4+n</entry> + <entry></entry> + <entry>request length</entry> + </row> + <row> + <entry>4</entry> + <entry>DRAWABLE</entry> + <entry></entry> + <entry>drawable</entry> + </row> + <row> + <entry>4</entry> + <entry>GCONTEXT</entry> + <entry></entry> + <entry>gc</entry> + </row> + <row> + <entry>4n</entry> + <entry>LISTofPOINT</entry> + <entry></entry> + <entry>points</entry> + </row> + </tbody> + </tgroup> +</informaltable> + +<para>Extended-length protocol encodings, once enabled, can be used on all protocol requests, including all extensions.</para> +</chapter> + +<chapter id='requests'> +<title>Requests</title> + +<para><function>BigReqEnable</function></para> + +<para> =></para> + +<para><emphasis remap='I'>maximum-request-length</emphasis>: CARD32</para> + +<para>This request enables extended-length protocol requests for the requesting client. It also returns the maximum length of a request, in 4-byte units, that can be used in extended-length protocol requests. This value will always be greater than the maximum-request-length returned in the connection setup information.</para> +</chapter> + +<chapter id='events_and_errors'> +<title>Events and Errors</title> + +<para>No new events or errors are defined by this extension.</para> +</chapter> + +<chapter id='encoding'> +<title>Encoding</title> + +<para>Please refer to the X11 Protocol Encoding document as this document uses conventions established there.</para> + +<para>The name of this extension is “BIG-REQUESTS”.</para> + +<informaltable pgwide='0' frame='none'> + <tgroup cols='3' align='left'> + <colspec colwidth='0.5in' colname='c1'/> + <colspec colwidth='0.5in' colname='c2'/> + <colspec colwidth='2.0in' colname='c3'/> + <thead> + <row> + <entry namest="c1" nameend="c3">BigReqEnable</entry> + </row> + </thead> + <tbody> + <row> + <entry>1</entry> + <entry>Card8</entry> + <entry>opcode</entry> + </row> + <row> + <entry>1</entry> + <entry>0</entry> + <entry>bigreq opcode</entry> + </row> + <row> + <entry>2</entry> + <entry>1</entry> + <entry>request length</entry> + </row> + </tbody> + </tgroup> + <tgroup cols='3' align='left'> + <colspec colwidth='0.5in' colname='c1'/> + <colspec colwidth='1.5in' colname='c2'/> + <colspec colwidth='2.0in' colname='c3'/> + <thead> + <row> + <entry namest="c1" nameend="c3">=></entry> + </row> + </thead> + <tbody> + <row> + <entry>1</entry> + <entry>1</entry> + <entry>Reply</entry> + </row> + <row> + <entry>1</entry> + <entry></entry> + <entry>unused</entry> + </row> + <row> + <entry>2</entry> + <entry>CARD16</entry> + <entry>sequence number</entry> + </row> + <row> + <entry>4</entry> + <entry>0</entry> + <entry>length</entry> + </row> + <row> + <entry>4</entry> + <entry>CARD32</entry> + <entry>maximum-request-length</entry> + </row> + <row> + <entry>2</entry> + <entry>0</entry> + <entry>unused</entry> + </row> + </tbody> + </tgroup> +</informaltable> + +</chapter> + +<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>To permit clients to know what the maximum-request-length for extended-length encodings is, the following function is added to Xlib: + +<funcsynopsis> +<funcprototype> + <funcdef>long <function>XExtendedMaxRequestSize</function></funcdef> + <paramdef>Display <parameter> *display</parameter></paramdef> +</funcprototype> +</funcsynopsis> + +Returns zero (0) if the specified display does not support this extension, otherwise returns the maximum-request-length (in 4-byte units) supported by the server through the extended-length encoding.</para> +</chapter> + +<chapter id='acknowledgements'> +<title>Acknowledgements</title> + +<para>Clive Feather (IXI) originated the extended-length encoding used in this extension proposal.</para> +</chapter> +</book> |