libxtst: Changes to 'debian-unstable'
ChangeLog | 242 ++++++++++++++++++++++++++++++++++++++++++++
Makefile.am | 6 -
configure.ac | 83 +++++++--------
debian/changelog | 11 ++
debian/control | 33 +++++-
debian/libxtst-dev.install | 1
debian/libxtst-doc.install | 1
debian/rules | 59 ++++++----
docbook.am | 105 +++++++++++++++++++
man/XTest.xml | 36 +++---
specs/.gitignore | 3
specs/Makefile.am | 63 +----------
specs/recordlib.xml | 243 +++++++++++++++++++++------------------------
specs/xtestlib.xml | 81 ++++++---------
src/XRecord.c | 22 ++--
src/XTest.c | 4
16 files changed, 664 insertions(+), 329 deletions(-)
New commits:
commit 15ec4f96cd0308dd12ff6e81cb2db70180524472
Author: Julien Cristau <jcristau@debian.org>
Date: Mon Apr 23 22:55:51 2012 +0200
Upload to unstable
diff --git a/debian/changelog b/debian/changelog
index ac37ab3..cc85c41 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,4 +1,4 @@
-libxtst (2:1.2.1-1) UNRELEASED; urgency=low
+libxtst (2:1.2.1-1) unstable; urgency=low
* New upstream release.
* Split documentation to a separate package. Mark libxtst-dev Multi-Arch:
@@ -7,7 +7,7 @@ libxtst (2:1.2.1-1) UNRELEASED; urgency=low
* Bump build-deps on xutils-dev, xmlto and xorg-sgml-doctools per
configure.ac.
- -- Julien Cristau <jcristau@debian.org> Mon, 23 Apr 2012 22:10:45 +0200
+ -- Julien Cristau <jcristau@debian.org> Mon, 23 Apr 2012 22:55:46 +0200
libxtst (2:1.2.0-4) unstable; urgency=low
commit 11dd49fec0547916545b7cbdad3d4700c32c30d8
Author: Julien Cristau <jcristau@debian.org>
Date: Mon Apr 23 22:31:57 2012 +0200
Bump build-deps on xutils-dev, xmlto and xorg-sgml-doctools per configure.ac.
diff --git a/debian/changelog b/debian/changelog
index 3fd4db1..ac37ab3 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -4,6 +4,8 @@ libxtst (2:1.2.1-1) UNRELEASED; urgency=low
* Split documentation to a separate package. Mark libxtst-dev Multi-Arch:
same.
* Don't build the documentation from the build-arch target.
+ * Bump build-deps on xutils-dev, xmlto and xorg-sgml-doctools per
+ configure.ac.
-- Julien Cristau <jcristau@debian.org> Mon, 23 Apr 2012 22:10:45 +0200
diff --git a/debian/control b/debian/control
index 17200b7..ce621e8 100644
--- a/debian/control
+++ b/debian/control
@@ -16,10 +16,12 @@ Build-Depends:
xmlto,
automake,
libtool,
- xutils-dev (>= 1:7.5+4),
+ xutils-dev (>= 1:7.6+2),
quilt,
# specs:
- xmlto, xorg-sgml-doctools (>= 1:1.5), w3m,
+ xmlto (>= 0.0.22),
+ xorg-sgml-doctools (>= 1:1.8),
+ w3m,
Standards-Version: 3.8.3
Vcs-Git: git://git.debian.org/git/pkg-xorg/lib/libxtst
Vcs-Browser: http://git.debian.org/?p=pkg-xorg/lib/libxtst.git
commit fc015471425e94d2cdb1e5749cb37a6e492b35bf
Author: Julien Cristau <jcristau@debian.org>
Date: Mon Apr 23 22:29:43 2012 +0200
Don't build the documentation from the build-arch target.
diff --git a/debian/changelog b/debian/changelog
index 67cda1f..3fd4db1 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -3,6 +3,7 @@ libxtst (2:1.2.1-1) UNRELEASED; urgency=low
* New upstream release.
* Split documentation to a separate package. Mark libxtst-dev Multi-Arch:
same.
+ * Don't build the documentation from the build-arch target.
-- Julien Cristau <jcristau@debian.org> Mon, 23 Apr 2012 22:10:45 +0200
diff --git a/debian/rules b/debian/rules
index 6fbe494..a1bdb0b 100755
--- a/debian/rules
+++ b/debian/rules
@@ -33,8 +33,12 @@ else
confflags += --build=$(DEB_BUILD_GNU_TYPE) --host=$(DEB_HOST_GNU_TYPE)
endif
+build: build-indep
+build-indep: docflags = --enable-specs --with-xmlto --without-fop
+build-indep: build-stamp
+build-arch: docflags = --disable-specs
+build-arch: build-stamp
-build: build-stamp
build-stamp: $(STAMP_DIR)/patch
dh_testdir
autoreconf -vfi
@@ -44,7 +48,7 @@ build-stamp: $(STAMP_DIR)/patch
--infodir=\$${prefix}/share/info $(confflags) \
--libdir=\$${prefix}/lib/$(DEB_HOST_MULTIARCH) \
--docdir=\$${prefix}/share/doc/libxtst-dev \
- --with-xmlto --without-fop \
+ $(docflags) \
CFLAGS="$(CFLAGS)"
cd build && $(MAKE)
>$@
@@ -52,7 +56,6 @@ build-stamp: $(STAMP_DIR)/patch
clean: xsfclean
dh_testdir
rm -f build-stamp
-
rm -f config.cache config.log config.status
rm -f */config.cache */config.log */config.status
rm -f conftest* */conftest*
@@ -61,10 +64,9 @@ clean: xsfclean
rm -f INSTALL aclocal.m4 config.guess config.sub config.h.in configure
rm -f depcomp install-sh ltmain.sh missing mkinstalldirs
find -name Makefile.in -delete
-
dh_clean
-install: build
+install: build-stamp
dh_testdir
dh_testroot
dh_clean -k
@@ -73,29 +75,40 @@ install: build
cd build && $(MAKE) DESTDIR=$(CURDIR)/debian/tmp install
# Build architecture-dependent files here.
-binary-arch: build install
+binary-arch: build-arch install
dh_testdir
dh_testroot
-
- dh_installdocs
- dh_install --sourcedir=debian/tmp --fail-missing -XlibXtst.la
- dh_installchangelogs ChangeLog
- dh_installman
- dh_link
+ dh_installdocs -s
+ dh_install -s --sourcedir=debian/tmp --fail-missing -XlibXtst.la
+ dh_installchangelogs -s ChangeLog
+ dh_installman -s
+ dh_link -s
dh_strip -p$(PACKAGE) --dbg-package=$(PACKAGE)-dbg
- dh_strip -N$(PACKAGE)
- dh_compress
- dh_fixperms
- dh_makeshlibs --add-udeb=$(PACKAGE)-udeb
- dh_shlibdeps
- dh_installdeb
- dh_gencontrol
- dh_md5sums
- dh_builddeb
+ dh_strip -s -N$(PACKAGE)
+ dh_compress -s
+ dh_fixperms -s
+ dh_makeshlibs -s --add-udeb=$(PACKAGE)-udeb
+ dh_shlibdeps -s
+ dh_installdeb -s
+ dh_gencontrol -s
+ dh_md5sums -s
+ dh_builddeb -s
# Build architecture-independent files here.
-binary-indep: build install
-# Nothing to do
+binary-indep: build-indep install
+ dh_testdir
+ dh_testroot
+ dh_installdocs -i
+ dh_install -i --sourcedir=debian/tmp --fail-missing -XlibXtst.la
+ dh_installchangelogs -i ChangeLog
+ dh_installman -i
+ dh_link -i
+ dh_compress -i
+ dh_fixperms -i
+ dh_installdeb -i
+ dh_gencontrol -i
+ dh_md5sums -i
+ dh_builddeb -i
binary: binary-indep binary-arch
.PHONY: build clean binary-indep binary-arch binary install
commit 1990253441d16f8577866779709437cb253b7d85
Author: Julien Cristau <jcristau@debian.org>
Date: Mon Apr 23 22:26:19 2012 +0200
Split documentation to a separate package.
Mark libxtst-dev Multi-Arch: same.
diff --git a/debian/changelog b/debian/changelog
index 6c79ff7..67cda1f 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,6 +1,8 @@
libxtst (2:1.2.1-1) UNRELEASED; urgency=low
* New upstream release.
+ * Split documentation to a separate package. Mark libxtst-dev Multi-Arch:
+ same.
-- Julien Cristau <jcristau@debian.org> Mon, 23 Apr 2012 22:10:45 +0200
diff --git a/debian/control b/debian/control
index 0e5f0a2..17200b7 100644
--- a/debian/control
+++ b/debian/control
@@ -76,6 +76,7 @@ Description: X11 Record extension library (debug package)
Package: libxtst-dev
Section: libdevel
Architecture: any
+Multi-Arch: same
Depends:
${shlibs:Depends},
${misc:Depends},
@@ -103,3 +104,29 @@ Description: X11 Record extension library (development headers)
.
This module can be found at
git://anongit.freedesktop.org/git/xorg/lib/libXtst
+
+Package: libxtst-doc
+Section: doc
+Architecture: all
+Multi-Arch: foreign
+Depends:
+ ${misc:Depends},
+Replaces:
+ libxtst-dev (<< 2:1.2.1),
+Breaks:
+ libxtst-dev (<< 2:1.2.1),
+Description: X11 Record extension library (documentation)
+ libXtst provides an X Window System client interface to the Record
+ extension to the X protocol.
+ .
+ The Record extension allows X clients to synthesise input events, which
+ is useful for automated testing.
+ .
+ This package contains the API documentation for the X Record and XTEST
+ extension libraries. Non-developers likely have little use for this package.
+ .
+ More information about X.Org can be found at:
+ <URL:http://www.X.org>
+ .
+ This module can be found at
+ git://anongit.freedesktop.org/git/xorg/lib/libXtst
diff --git a/debian/libxtst-dev.install b/debian/libxtst-dev.install
index 5d98180..bd5ad4c 100644
--- a/debian/libxtst-dev.install
+++ b/debian/libxtst-dev.install
@@ -3,4 +3,3 @@ usr/lib/*/libXtst.so
usr/lib/*/pkgconfig/xtst.pc
usr/share/man/man3
usr/include/X11/extensions/
-usr/share/doc/libxtst-dev/
diff --git a/debian/libxtst-doc.install b/debian/libxtst-doc.install
new file mode 100644
index 0000000..580c854
--- /dev/null
+++ b/debian/libxtst-doc.install
@@ -0,0 +1 @@
+usr/share/doc/libxtst-dev/
commit 62c8fb27d9eaf40a1d36458a96fb253a19fcdac5
Author: Julien Cristau <jcristau@debian.org>
Date: Mon Apr 23 22:11:04 2012 +0200
Bump changelogs
diff --git a/ChangeLog b/ChangeLog
index 9c34936..4677bec 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,245 @@
+commit eb177d24ffb459af6205d2658c3a158449660caf
+Author: Alan Coopersmith <alan.coopersmith@oracle.com>
+Date: Wed Mar 7 21:11:34 2012 -0800
+
+ libXtst 1.2.1
+
+ Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
+
+commit 6150958c2ae61ce82aa15f3a80107dd01278b255
+Author: Alan Coopersmith <alan.coopersmith@oracle.com>
+Date: Thu Nov 10 21:43:16 2011 -0800
+
+ Fix gcc -Wwrite-strings warnings
+
+ Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
+
+commit 558ec1d7194307d7ce73aeae2f4f61df9d44bba0
+Author: Matt Dew <marcoz@osource.org>
+Date: Tue Oct 4 21:50:03 2011 -0600
+
+ Cleanup IDs and links in doc
+
+ 1 - fix the capitalization of the ID attributes to match either the
+ <title> or <funcdef> string it goes with.
+ 2 - fix any <linkend>'s that were affected by 1.
+ 3 - any <function> in the docs that has an actual funcdef,
+ will become an olink.
+
+ Signed-off-by: Matt Dew <marcoz@osource.org>
+
+commit 262904c22154d5a703ef92a7f954e52956b13663
+Author: Gaetan Nadon <memsize@videotron.ca>
+Date: Tue Sep 20 15:30:22 2011 -0400
+
+ specs: refactor copyright legal text for multi licensing
+
+ Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
+
+commit 8f68b59f2b66f035ad97e3fe99e9eae983d1f44b
+Author: Alan Coopersmith <alan.coopersmith@oracle.com>
+Date: Fri Sep 16 22:55:23 2011 -0700
+
+ Strip trailing whitespace
+
+ Performed with: find * -type f | xargs perl -i -p -e 's{[ \t]+$}{}'
+ git diff -w & git diff -b show no diffs from this change
+
+ Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
+
+commit 01dc43ee0fbdb1ed2397a735dfb69b0434600a20
+Author: Gaetan Nadon <memsize@videotron.ca>
+Date: Fri Sep 16 16:57:52 2011 -0400
+
+ xtestlib: remove duplicate paragraph in legal notice
+
+ Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
+
+commit d03495e02bf43e9605671d8f6474c1e9e45261e2
+Author: Gaetan Nadon <memsize@videotron.ca>
+Date: Fri Sep 16 16:55:48 2011 -0400
+
+ specs: fix author affiliation
+
+ Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
+
+commit b5e58980988017265c239a2bad11489a7ab06c23
+Author: Gaetan Nadon <memsize@videotron.ca>
+Date: Mon Sep 12 16:54:45 2011 -0400
+
+ docs: use the &fullrelvers; entity to set X11 release information
+
+ Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
+
+commit 743447eaeab62b5e1d5951706cc99d51c0261bbf
+Author: Gaetan Nadon <memsize@videotron.ca>
+Date: Sun Sep 11 19:49:54 2011 -0400
+
+ docs: remove <productnumber> which is not used by default
+
+ This element is not rendered by default on the title. A template
+ customization is required to display it.
+ X Window System does not have a product number.
+
+ Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
+
+commit c6be40edba1fe8557ebd0b1cc09b3480bc7d6bb8
+Author: Gaetan Nadon <memsize@videotron.ca>
+Date: Thu Sep 8 20:00:00 2011 -0400
+
+ docbook.am: embed css styles inside the HTML HEAD element
+
+ Rather than referring to the external xorg.css stylesheet, embed the content
+ of the file in the html output produced. This is accomplished by using
+ version 1.10 of xorg-xhtml.xsl.
+
+ This makes the whole html docs tree much more relocatable.
+ In addition, it eliminates xorg.css as a runtime file which makes
+ xorg-sgml-doctools a build time only package.
+
+ Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
+
+commit ee829b31b27580afbd6e16f81d9ef3526514be8e
+Author: Gaetan Nadon <memsize@videotron.ca>
+Date: Wed Sep 7 10:31:04 2011 -0400
+
+ docbook.am: global maintenance update - entities, images and olinking
+
+ Adding support in libX11 for html chunking caused a reorg of docbook.am
+ as well as the xorg-sgml-doctools masterdb for olinking.
+ The parameter img.src.path is added for pdf images.
+ A searchpath to the root builddir is added for local entities, if present.
+
+ The docbook.am makefile hides all the details and is identical for
+ all 22 modules having DocBook documentation. It is included by a thin
+ Makefile.am which requires no docbook knowledge.
+
+ Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
+
+commit b8c1a91ed12488999dee915953b5bc36019bbf95
+Author: Gaetan Nadon <memsize@videotron.ca>
+Date: Sun Jun 12 18:39:46 2011 -0400
+
+ Install xml versions of specs even if HAVE_XMLTO is false
+
+ DocBook/XML input source is also a usefull output format that can be viewed
+ with an XML viewer or editor and by some O/S help system.
+
+ Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
+
+commit 9656d08c2c01965aa57f21f29cc2261b9d015b3c
+Author: Gaetan Nadon <memsize@videotron.ca>
+Date: Sun Jun 5 16:27:37 2011 -0400
+
+ Install target dbs alongside generated documents
+
+ This matches a change in xorg-sgml-docs whereby the masterdb will look for
+ the target dbs into the same location as the generated documents.
+
+ The target dbs are now installed alongside the generated documents.
+ Previously they are installed in $prefix/sgml/X11/dbs alongside masterdb which
+ has the potential of installing outside the package prefix and cause
+ distcheck to fail when user does not have write permission in this package.
+
+ Requires XORG_CHECK_SGML_DOCTOOLS(1.8) which was released 2011-06-11
+
+commit c131572b98342e0e2a599619647dd1835c740ee4
+Author: Matt Dew <marcoz@osource.org>
+Date: Tue May 31 20:03:23 2011 -0600
+
+ Add id attributes to funcsynopsis to allow other docs to olink to them.
+
+ Signed-off-by: Matt Dew <marcoz@osource.org>
+ Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com>
+ Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
+
+commit c82effa402128366bfd3cfb77da82d524ddb878f
+Author: Gaetan Nadon <memsize@videotron.ca>
+Date: Sun Feb 27 15:06:18 2011 -0500
+
+ Documentation: add Docbook external references support
+
+ When writing technical documentation, it is often necessary to cross
+ reference to other information. When that other information is not in the
+ current document, additional support is needed, namely <olink>.
+
+ A new feature with version 1.7 of xorg-sgml-doctools adds references to
+ other documents within or outside this package.
+
+ This patch adds technical support for this feature but does not change
+ the content of the documentation as seen by the end user.
+
+ Each book or article must generate a database containing the href
+ of sections that can be referred to from another document. This database
+ is installed in DATAROOTDIR/sgml/X11/dbs. There is a requirement that
+ the value of DATAROOTDIR for xorg-sgml-doctools and for the package
+ documentation is the same. This forms a virtual document tree.
+
+ This database is consulted by other documents while they are being generated
+ in order to fulfill the missing information for linking.
+ Refer to the xorg-sgml-doctools for further technical information.
+
+ Co-authored-by: Matt Dew <marcoz@osource.org>
+
+ Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
+
+commit 755e43b9a05dfce2564cd62cf97364db94a62731
+Author: Gaetan Nadon <memsize@videotron.ca>
+Date: Wed Feb 2 11:43:45 2011 -0500
+
+ config: comment, minor upgrade, quote and layout configure.ac
+
+ Group statements per section as per Autoconf standard layout
+ Quote statements where appropriate.
+ Autoconf recommends not using dnl instead of # for comments
+
+ Use AC_CONFIG_FILES to replace the deprecated AC_OUTPUT with parameters.
+ Add AC_CONFIG_SRCDIR([Makefile.am])
+
+ This helps automated maintenance and release activities.
+ Details can be found in http://wiki.x.org/wiki/NewModuleGuidelines
+
+commit 97eab9c4e103b6b18f1307d42c4ab15bc80b8db7
+Author: Gaetan Nadon <memsize@videotron.ca>
+Date: Fri Jan 28 19:41:37 2011 -0500
+
+ config: replace deprecated AM_CONFIG_HEADER with AC_CONFIG_HEADERS
+
+ Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
+
+commit a0154ff17ac2f7d08e26e82cc211f61935acf229
+Author: Gaetan Nadon <memsize@videotron.ca>
+Date: Thu Jan 27 18:50:15 2011 -0500
+
+ config: remove AC_PROG_CC as it overrides AC_PROG_C_C99
+
+ XORG_STRICT_OPTION from XORG_DEFAULT_OPTIONS calls
+ AC_PROG_C_C99. This sets gcc with -std=gnu99.
+ If AC_PROG_CC macro is called afterwards, it resets CC to gcc.
+
+ Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
+
+commit 22ae1c003879ccddb4143669275c5b8071f713a8
+Author: Paulo Zanoni <pzanoni@mandriva.com>
+Date: Thu Dec 16 14:11:43 2010 -0200
+
+ Use docbookx.dtd version 4.3 for all docs
+
+ Signed-off-by: Paulo Zanoni <pzanoni@mandriva.com>
+ Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
+
+commit e8ac35fac1974b9fd698f74c143c9691af5dd688
+Author: Gaetan Nadon <memsize@videotron.ca>
+Date: Tue Nov 9 13:04:59 2010 -0500
+
+ config: HTML file generation: use the installed copy of xorg.css
+
+ Currenlty the xorg.css file is copied in each location
+ where a DocBook/XML file resides. This produces about
+ 70 copies in the $(docdir) install tree.
+
+ Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
+
commit 5c6834bc9e0ab78c78733c59046510a2f48b2d42
Author: Alan Coopersmith <alan.coopersmith@oracle.com>
Date: Fri Oct 29 17:38:10 2010 -0700
diff --git a/debian/changelog b/debian/changelog
index 2c5be64..6c79ff7 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+libxtst (2:1.2.1-1) UNRELEASED; urgency=low
+
+ * New upstream release.
+
+ -- Julien Cristau <jcristau@debian.org> Mon, 23 Apr 2012 22:10:45 +0200
+
libxtst (2:1.2.0-4) unstable; urgency=low
[ Julien Cristau ]
commit eb177d24ffb459af6205d2658c3a158449660caf
Author: Alan Coopersmith <alan.coopersmith@oracle.com>
Date: Wed Mar 7 21:11:34 2012 -0800
libXtst 1.2.1
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
diff --git a/configure.ac b/configure.ac
index d9fffab..1f2927f 100644
--- a/configure.ac
+++ b/configure.ac
@@ -22,7 +22,7 @@
# Initialize Autoconf
AC_PREREQ([2.60])
-AC_INIT([libXtst], [1.2.0],
+AC_INIT([libXtst], [1.2.1],
[https://bugs.freedesktop.org/enter_bug.cgi?product=xorg], [libXtst])
AC_CONFIG_SRCDIR([Makefile.am])
AC_CONFIG_HEADERS([config.h])
commit 6150958c2ae61ce82aa15f3a80107dd01278b255
Author: Alan Coopersmith <alan.coopersmith@oracle.com>
Date: Thu Nov 10 21:43:16 2011 -0800
Fix gcc -Wwrite-strings warnings
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
diff --git a/src/XRecord.c b/src/XRecord.c
index 69d6120..b65451c 100644
--- a/src/XRecord.c
+++ b/src/XRecord.c
@@ -59,7 +59,7 @@ from The Open Group.
static XExtensionInfo _xrecord_info_data;
static XExtensionInfo *xrecord_info = &_xrecord_info_data;
-static /* const */ char *xrecord_extension_name = RECORD_NAME;
+static const char *xrecord_extension_name = RECORD_NAME;
#define XRecordCheckExtension(dpy,i,val) \
XextCheckExtension(dpy, i, xrecord_extension_name, val)
diff --git a/src/XTest.c b/src/XTest.c
index 759e0e8..3e4bb17 100644
--- a/src/XTest.c
+++ b/src/XTest.c
@@ -40,7 +40,7 @@ from The Open Group.
static XExtensionInfo _xtest_info_data;
static XExtensionInfo *xtest_info = &_xtest_info_data;
-static /* const */ char *xtest_extension_name = XTestExtensionName;
+static const char *xtest_extension_name = XTestExtensionName;
#define XTestCheckExtension(dpy,i,val) \
XextCheckExtension (dpy, i, xtest_extension_name, val)
commit 558ec1d7194307d7ce73aeae2f4f61df9d44bba0
Author: Matt Dew <marcoz@osource.org>
Date: Tue Oct 4 21:50:03 2011 -0600
Cleanup IDs and links in doc
1 - fix the capitalization of the ID attributes to match either the
<title> or <funcdef> string it goes with.
2 - fix any <linkend>'s that were affected by 1.
3 - any <function> in the docs that has an actual funcdef,
will become an olink.
Signed-off-by: Matt Dew <marcoz@osource.org>
diff --git a/specs/recordlib.xml b/specs/recordlib.xml
index 85cdaf4..08d3eb2 100644
--- a/specs/recordlib.xml
+++ b/specs/recordlib.xml
@@ -67,7 +67,7 @@ X Consortium.
</legalnotice>
</bookinfo>
-<chapter id="record_extension_overview">
+<chapter id='Record_Extension_Overview'>
<title>Record Extension Overview</title>
<para>
The purpose of this extension is to support the recording and reporting of
@@ -76,7 +76,7 @@ gives an overview of the Record extension. The following sections describe
how to use the Record extension library.
</para>
-<sect1 id="synchronous_playback">
+<sect1 id='Synchronous_Playback'>
<title>Synchronous Playback</title>
<para>
Environment information is generally provided to an X-based playback
@@ -113,7 +113,7 @@ synchronization methodology.
</para>
</sect1>
-<sect1 id="design_approach">
+<sect1 id='Design_Approach'>
<title>Design Approach</title>
<para>
The design approach of the extension is to record core X protocol and
@@ -125,7 +125,7 @@ events, including input device events that do not go to any clients.
</para>
</sect1>
-<sect1 id="record_clients">
+<sect1 id='Record_Clients'>
<title>Record Clients</title>
<para>
The recommended communication model for a Record application is to open two
@@ -144,14 +144,13 @@ recording operations.
<para>
A client that wishes to record X protocol does so through the library
functions defined in
-<link linkend="library_extension_requests">
-<xref linkend="library_extension_requests"></xref></link>
+<xref linkend='Library_Extension_Requests' xrefstyle='select: title'/>
A typical sequence of requests that a client would make is as follows:
</para>
<itemizedlist>
<listitem>
<para>
-<function>XRecordQueryVersion</function>
+<xref linkend='XRecordQueryVersion' xrefstyle='select: title'/>
</para>
<para>
query the extension protocol version.
@@ -159,7 +158,7 @@ query the extension protocol version.
</listitem>
<listitem>
<para>
-<function>XRecordCreateContext</function>
+<xref linkend='XRecordCreateContext' xrefstyle='select: title'/>
</para>
<para>
request that the server create a record context for access by this client,
@@ -170,7 +169,7 @@ used by most other extension requests to identify the specified context.
</listitem>
<listitem>
<para>
-<function>XRecordEnableContext</function>
+<xref linkend='XRecordEnableContext' xrefstyle='select: title'/>
</para>
<para>
begin the recording and reporting of protocol data.
@@ -178,7 +177,7 @@ begin the recording and reporting of protocol data.
</listitem>
<listitem>
<para>
-<function>XRecordDisableContext</function>
+<xref linkend='XRecordDisableContext' xrefstyle='select: title'/>
</para>
<para>
end the recording and reporting of protocol data.
@@ -186,7 +185,7 @@ end the recording and reporting of protocol data.
</listitem>
<listitem>
<para>
-<function>XRecordFreeContext</function>
+<xref linkend='XRecordFreeContext' xrefstyle='select: title'/>
</para>
<para>
free the record context.
@@ -205,11 +204,11 @@ The <function>Xtst</function> library contains the
</sect1>
</chapter>
-<chapter id="common_arguments">
+<chapter id='Common_Arguments'>
<title>Common Arguments</title>
<para>
-The Record extension functions <function>XRecordCreateContext</function>
- and <function>XRecordRegisterClients</function> allow applications to
+The Record extension functions <xref linkend='XRecordCreateContext' xrefstyle='select: title'/>
+ and <xref linkend='XRecordRegisterClients' xrefstyle='select: title'/> allow applications to
specify the following:
</para>
<itemizedlist>
@@ -231,21 +230,20 @@ recording client although it may not be sent to a recorded client. The
device_events type differs from delivered_events, which also can be
specified by a recording client; delivered_events are actually delivered to
one or more clients. These event types are discussed in
-<link linkend="protocol_ranges">
-<xref linkend="protocol_ranges"></xref></link>
+<xref linkend='Protocol_Ranges' xrefstyle='select: title'/>
</para>
<para>
-The Record extension functions <function>XRecordCreateContext</function>
- and <function>XRecordRegisterClients</function> have the common arguments
+The Record extension functions <xref linkend='XRecordCreateContext' xrefstyle='select: title'/>
+ and <xref linkend='XRecordRegisterClients' xrefstyle='select: title'/> have the common arguments
datum_flags, clients, and ranges, which specify whether server time
and/or client sequence number should precede protocol elements, the
clients or client set to record, and the protocol ranges to record,
respectively. These are discussed in the following sections.
</para>
-<sect1 id="datum_flags">
+<sect1 id='Datum_Flags'>
<title>Datum Flags</title>
<para>
The datum_flags argument is a set of flags OR’ed together to specify options
@@ -274,7 +272,7 @@ The <function>XRecordFromClientSequence</function> flag specifies that
</para>
</sect1>
-<sect1 id="selecting_clients">
+<sect1 id='Selecting_Clients'>
<title>Selecting Clients</title>
<para>
@@ -299,8 +297,7 @@ If the element in the array identifies a particular client, protocol
specified by the ranges argument will be recorded by the server. The
recorded protocol data will not be returned to the recording client until
the record context has been enabled. This is described in
-<link linkend="data_transfer">
-<xref linkend="data_transfer"></xref></link>
+<xref linkend='Data_Transfer' xrefstyle='select: title'/>
</para>
<para>
If the element is <function>XRecordCurrentClients</function>, the protocol
@@ -320,12 +317,12 @@ silently exclude the recording data connection. It is an error to explicitly
register the data connection.
</para>
</sect1>
-<sect1 id="protocol_ranges">
+<sect1 id='Protocol_Ranges'>
<title>Protocol Ranges</title>
<para>
-The functions <function>XRecordCreateContext</function> and
-<function>XRecordRegisterClients</function> have another common argument,
+The functions <xref linkend='XRecordCreateContext' xrefstyle='select: title'/> and
+<xref linkend='XRecordRegisterClients' xrefstyle='select: title'/> have another common argument,
ranges, which is an array of pointers to <function>XRecordRange</function>
structures. Each structure contains ranges of numeric values for each of
the protocol types that can be specified and recorded individually by the
@@ -507,7 +504,7 @@ notification when a client disconnects is not specified by this
</sect1>
</chapter>
-<chapter id='library_extension_requests'>
+<chapter id='Library_Extension_Requests'>
<title>Library Extension Requests</title>
<para>
@@ -522,17 +519,17 @@ or
errors.
</para>
-<sect1 id='query_extension_version'>
+<sect1 id='Query_Extension_Version'>
<title>Query Extension Version</title>
<para>
An application uses the
-<function>XRecordQueryVersion</function>
+<xref linkend='XRecordQueryVersion' xrefstyle='select: title'/>
function to determine
the version of the Record extension protocol supported by an X server.
</para>
-<funcsynopsis id='xrecordqueryversion'>
+<funcsynopsis id='XRecordQueryVersion'>
<funcprototype>
<funcdef>Status <function>XRecordQueryVersion</function></funcdef>
<paramdef>Display <parameter> *display</parameter></paramdef>
@@ -558,27 +555,27 @@ the version of the Record extension protocol supported by an X server.
<para>
The
-<function>XRecordQueryVersion</function>
+<xref linkend='XRecordQueryVersion' xrefstyle='select: title'/>
function returns the major and minor protocol version numbers supported by
the server.
-<function>XRecordQueryVersion</function>
+<xref linkend='XRecordQueryVersion' xrefstyle='select: title'/>
returns nonzero (success) only if the returned version numbers are
common to both the library and the server; otherwise, it returns zero.
</para>
</sect1>
-<sect1 id='create_and_modify_context'>
+<sect1 id='Create_and_Modify_Context'>
<title>Create and Modify Context</title>
<para>
An application uses the
-<function>XRecordCreateContext</function>
+<xref linkend='XRecordCreateContext' xrefstyle='select: title'/>
function to create a record context. At the time the record context is
created by the recording client, the clients to be recorded and the
protocol to record for each client may be specified.
</para>
-<funcsynopsis id='xrecordcreatecontext'>
+<funcsynopsis id='XRecordCreateContext'>
<funcprototype>
<funcdef>XRecordContext <function>XRecordCreateContext</function></funcdef>
<paramdef>Display <parameter> *display</parameter></paramdef>
@@ -619,15 +616,14 @@ protocol to record for each client may be specified.
<para>
The
-<function>XRecordCreateContext</function>
+<xref linkend='XRecordCreateContext' xrefstyle='select: title'/>
function creates a record context and returns an
<function>XRecordContext</function>
which is then used in the other Record library calls. This request is
typically executed by the recording client over its control connection to
the X server. The datum_flags specifies whether server time and/or client
sequence number should precede protocol elements recorded by context (
-<link linkend="datum_flags">
-<xref linkend="datum_flags"></xref></link>
+<xref linkend='Datum_Flags' xrefstyle='select: title'/>
). When a clients element identifies a particular client, the client is added
to the context and the protocol to record for that client is set to the
union of all ranges. When a clients element is
@@ -636,15 +632,14 @@ union of all ranges. When a clients element is
or
<function>XRecordAllClients</function>
the actions described in
-<link linkend="selecting_clients">
-<xref linkend="selecting_clients"></xref></link>
+<xref linkend='Selecting_Clients' xrefstyle='select: title'/>
are performed.
</para>
<para>
-<function>XRecordCreateContext</function>
+<xref linkend='XRecordCreateContext' xrefstyle='select: title'/>
returns zero if the request failed.
-<function>XRecordCreateContext</function>
+<xref linkend='XRecordCreateContext' xrefstyle='select: title'/>
can generate
<function>BadIDChoice</function>
<function>BadMatch</function>
@@ -675,21 +670,21 @@ structure.
The structure is initialized to specify no protocol.
The function returns NULL if the structure allocation fails.
The application can free the structure by calling
-<function>XFree</function>
+<olink targetdoc='libX11' targetptr='XFree'><function>XFree</function></olink>
</para>
-<sect2 id='additions'>
+<sect2 id='Additions'>
<title>Additions</title>
<para>
An application uses the
-<function>XRecordRegisterClients</function>
+<xref linkend='XRecordRegisterClients' xrefstyle='select: title'/>
function to modify a previously created
record context, by adding clients or modifying the recorded protocol,
typically over its control connection to the X server.
</para>
-<funcsynopsis id='xrecordregisterclients'>
+<funcsynopsis id='XRecordRegisterClients'>
<funcprototype>
<funcdef>Status <function>XRecordRegisterClients</function></funcdef>
<paramdef>Display <parameter> *display</parameter></paramdef>
@@ -736,8 +731,7 @@ typically over its control connection to the X server.
<para>
The datum_flags specifies whether server time and/or client sequence number
should precede protocol elements for all clients recorded by context (See
-<link linkend="datum_flags">
-<xref linkend="datum_flags"></xref></link>
+<xref linkend='Datum_Flags' xrefstyle='select: title'/>
). When a clients element identifies a particular client and the client is
not yet targeted for recording in the given context, the client is added
to the set of clients to record, and the protocol to record for that client
@@ -749,19 +743,18 @@ is set to the union of all ranges. When the element is
or
<function>XRecordAllClients</function>
the actions described in
-<link linkend="selecting_clients">
-<xref linkend="selecting_clients"></xref></link>
+<xref linkend='Selecting_Clients' xrefstyle='select: title'/>
are performed.
</para>
<para>
-<function>XRecordRegisterClients</function>
+<xref linkend='XRecordRegisterClients' xrefstyle='select: title'/>
returns zero if the request failed; otherwise, it
returns nonzero.
</para>
<para>
-<function>XRecordRegisterClients</function>
+<xref linkend='XRecordRegisterClients' xrefstyle='select: title'/>
can generate
<function>XRecordBadContext</function>
<function>BadMatch</function>
@@ -771,7 +764,7 @@ errors.
</para>
</sect2>
-<sect2 id='deletions'>
+<sect2 id='Deletions'>
<title>Deletions</title>
<para>
@@ -781,7 +774,7 @@ function to delete clients from a previously created
record context, typically over its control connection to the X server.
</para>
-<funcsynopsis id='xrecordunregisterclients'>
+<funcsynopsis id='XRecordUnRegisterClients'>
<funcprototype>
<funcdef>Status <function>XRecordUnRegisterClients</function></funcdef>
<paramdef>Display <parameter> *display</parameter></paramdef>
@@ -857,17 +850,17 @@ errors.</para>
</sect2>
</sect1>
-<sect1 id='query_context_state'>
+<sect1 id='Query_Context_State'>
<title>Query Context State</title>
<para>
An application uses the
-<function>XRecordGetContext</function>
+<xref linkend='XRecordGetContext' xrefstyle='select: title'/>
function to query the current state of a record context, typically over
its control connection to the X server.
</para>
-<funcsynopsis id='xrecordgetcontext'>
+<funcsynopsis id='XRecordGetContext'>
<funcprototype>
<funcdef>Status <function>XRecordGetContext</function></funcdef>
<paramdef>Display <parameter> *display</parameter></paramdef>
@@ -897,7 +890,7 @@ the function stores a pointer to the current state of the record context.
The
Reply to: