Commit graph

210 commits

Author SHA1 Message Date
Gaetan Nadon
acd12d6096 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>
2011-09-08 20:10:08 -04:00
Gaetan Nadon
bd46f6d09c 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>
2011-09-07 14:39:22 -04:00
Alan Coopersmith
c270f8bed4 Fix Xfuncproto.h to work when #included in a C89-mode compilation
Variable argument macros are not supported in C89, only C99 or a
compiler-specific extension like gcc's.   Even just defining the
macro causes builds with C89 compilers to fail, as they can't
figure out how to handle #define _X_NONNULL(...), so only define
the fallback for C99 compilers.

Since this means C89 compilers will see _X_NONNULL unexpanded in
sources, add a comment to remind users that this should only be
used with #ifdef _X_NONNULL guards in public/exported API headers
we install for other software to compile against, so that we don't
break their builds.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Reviewed-by: Julien Cristau <jcristau@debian.org>
2011-08-30 16:29:29 -07:00
James Cloos
06ebd5b88b Add some keysyms to support Breton’s n-graphs.
These keysyms are necessary for XIM to support single-keystroke
multiple-character keys on Breton C’HWERTY keyboards.

Addresses: https://bugs.freedesktop.org/show_bug.cgi?id=34453

Signed-off-by: James Cloos <cloos@jhcloos.com>
Reviewed-by: Daniel Stone <daniel@fooishbar.org>
2011-06-29 09:24:51 -04:00
Peter Hutterer
42c16165df xproto 7.0.22
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2011-06-23 09:28:57 +10:00
Peter Hutterer
13799852a8 Add two more symbols for logging grab and window trees
These two keysyms provide exciting new possibilities of a close relationship
between our valued users and hard-working developers through innovative
logging solutions. Such keysyms truly pave new ground in the reponsiveness
to bug reports and and debug-ability of grabs.

For unprecedented uses of these keysyms, see the patches here:
http://patchwork.freedesktop.org/patch/5936/
http://patchwork.freedesktop.org/patch/5935/

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Daniel Stone <daniel@fooishbar.org>
2011-06-20 15:35:13 +10:00
Gaetan Nadon
7c3c4332d6 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>
2011-06-12 20:23:28 -04:00
Gaetan Nadon
c10589c12f 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
2011-06-11 19:49:23 -04:00
Cyril Brulebois
951295cceb Fix sorting by codepoint in Latin 2.
Sort performed by calling “sort -k 3” on the part between #ifdef
XK_LATIN8 and #endif.

Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Signed-off-by: Cyril Brulebois <kibi@debian.org>
2011-06-06 16:19:33 +02:00
Cyril Brulebois
d8920f71b6 build: Add SIAddresses as a subdir of specs.
Fix the following distcheck failure:
| configure: creating ./config.status
| config.status: creating Makefile
| config.status: creating specs/Makefile
| config.status: error: cannot find input file: `specs/SIAddresses/Makefile.in'
| make: *** [distcheck] Error 1

Signed-off-by: Cyril Brulebois <kibi@debian.org>
Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-06-04 13:01:22 -04:00
Alan Coopersmith
2ef6cb7ced spec: Add more indexterm & glossterm links
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2011-05-28 17:31:36 -07:00
Alan Coopersmith
0ffb15d698 spec: move id attributes for event definitions so fop can find them
FOP gives 'Unresolved ID reference "events:FocusOut" found.' errors
when the id attribute is on the emphasis tag, so moved up to the
surrounding entry tag.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2011-05-28 13:58:42 -07:00
Alan Coopersmith
41da11426e spec: Add zone attributes to indexterm tags for more stable link ids
Use named id's instead of autogenerating idXXXXXX values that change
in different versions so that it's easier to have stable links.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2011-05-28 13:58:38 -07:00
Alan Coopersmith
58897af838 spec: move &gt; outside emphasis to match &lt; in note after error list
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2011-05-28 11:04:17 -07:00
Alan Coopersmith
19b35215c9 spec: Syntactic Conventions examples should not be separate list entries
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2011-05-28 10:57:32 -07:00
Alan Coopersmith
e6ad4dd8d0 spec: Add cross-reference links in glossary to InputOnly & InputOutput
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2011-05-28 09:54:07 -07:00
Alan Coopersmith
2fc4719ba4 spec: Markup VoidSymbol and NoSymbol with <keysym> instead of <emphasis>
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2011-05-28 09:43:04 -07:00
Cyril Brulebois
9bbb6e3f83 Sort Latin 8 keysyms by codepoints.
The overall chaos misled implementors into writing interval checks to
determine the case, but that doesn't work too well when lines aren't
sorted.

Sort performed by calling “sort -k 3” on the part between #ifdef
XK_LATIN8 and #endif.

Signed-off-by: Cyril Brulebois <kibi@debian.org>
Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2011-05-27 21:22:46 -07:00
Alan Coopersmith
b283f6cba7 Add comments to Xfuncproto.h noting required xproto versions for each macro
Saves time trawling git logs to determine what to put in the call to
PKG_CHECK_MODULES in configure.ac when you start using one of these.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Reviewed-by: Jeremy Huddleston <jeremyhu@apple.com>
Acked-by: Cyril Brulebois <kibi@debian.org>
2011-05-25 18:36:19 -07:00
Jeremy Huddleston
217d1dae00 Add _X_NONNULL macro to annotate when a function expects arguments to be non-null
This will allow with compiler optimization and better static analysis.

Signed-off-by: Jeremy Huddleston <jeremyhu@apple.com>
Reviewed-by: Daniel Stone <daniel@fooishbar.org>
2011-04-28 18:23:56 -07:00
Jeremy Huddleston
6648db8f91 Add _X_UNUSED attribute to designate unused variables and silence warnings
Signed-off-by: Jeremy Huddleston <jeremyhu@apple.com>
Reviewed-by: Daniel Stone <daniel@fooishbar.org>
2011-04-28 18:23:36 -07:00
Matthieu Herrb
19c12c60c2 Fix __STDC_VERSION__ tests.
the existing test:
defined(__STDC__) && (__STDC_VERSION__ - 0 >= 199901L) causes an
warning when building X stuff with gcc -Wundef. Other tests for
 __STDC_VERSION__ in the X sources all use
defined(__STDC_VERSION__) && (__STDC_VERSION__ -0 >= 199901L)

Signed-off-by: Matthieu Herrb <matthieu.herrb@laas.fr>
Reviewed-by: Matt Turner <mattst88@gmail.com>
Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2011-04-21 07:20:38 +02:00
Gaetan Nadon
da46c2d0e1 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>
2011-03-30 20:18:36 -04:00
Peter Hutterer
452ae1076b xproto 7.0.21
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2011-03-23 11:44:18 +10:00
Harshula Jayasuriya
423f5faddb Add #defines for Unicode Sinhala to keysymdef.h
Add #defines for Unicode Sinhala so that they can be used in the lk XKB
keyboard layout.

Signed-off-by: Harshula Jayasuriya <harshula@gmail.com>
Reviewed-by: Daniel Stone <daniel@fooishbar.org>
2011-03-15 10:46:53 +00:00
Alan Coopersmith
f0c5b701a5 Support _X_INLINE in any C99-compliant compiler
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2011-02-24 20:13:20 -08:00
Alan Coopersmith
6eed63f745 Add missing notices to COPYING
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2011-01-06 22:24:33 -08:00
Alan Coopersmith
1870ec9ce4 Xfuncproto.h: Add _X_RESTRICT_KEYWORD for C99 & gcc in non-strict-C89 mode
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-13 16:26:06 -08:00
Alan Coopersmith
e5604f0448 Enable gcc attribute(__format__) on gcc versions older than 4.0
Enabled on 2.3 and up, since that's where it's available according to
http://www.ohse.de/uwe/articles/gcc-attributes.html#func-format

Tested with gcc 3.4.3 on Solaris.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Reviewed-by: Jeremy Huddleston <jeremyhu@apple.com>
2010-12-13 16:25:59 -08:00
Alan Coopersmith
d25f90fe26 xproto 7.0.20
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-07 19:05:26 -08:00
Alan Coopersmith
78806c9fc4 spec: Convert .DS/.DE nroff sections to <literallayout> tags
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-04 17:57:50 -08:00
Alan Coopersmith
f1309dd259 spec: Convert some tables that didn't get converted from troff properly
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-04 17:37:05 -08:00
Alan Coopersmith
19e314d952 Replace ASCII -> arrows with Unicode ▶
Matches formatting used in current extension specs like randr

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-04 16:28:52 -08:00
Alan Coopersmith
fa2daaceb0 spec: Make request names in text hyperlinks to request definition sections
Same basic process as previous commit for event names

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-04 16:14:53 -08:00
Alan Coopersmith
998f64c6c9 spec: Make event names in text hyperlinks to event definition sections
Started by taking list of event names and generating a list of perl
commands such as:
s{^\<emphasis role='bold'\>KeyPress\</emphasis\>}{<link linkend="events:KeyPress"><emphasis role='bold'>KeyPress</emphasis></link>}g;

and running that with perl -i -p /tmp/e.pl *.xml

Many of those changes were then manually reverted to avoid having
the same link appear multiple times in a paragraph or to avoid having
the definition sections link to themselves.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-04 16:14:53 -08:00
Alan Coopersmith
c4be93c218 spec: Convert Events chapter into sections
Started with a similar replace-regexp as the Requests chapter, but
with a lot more manual editing due to the sections with multiple
events grouped into a set.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-04 16:14:53 -08:00
Alan Coopersmith
eb772110ff spec: Convert Requests chapter to have a section per request
Bulk of change performed with emacs replace-regexp:
<para id="requests:[^"]+">
<emphasis role='bold'>\([^<]+\)</emphasis>
<indexterm significance="preferred"><primary>[^<]+</primary></indexterm>
</para>
with:
   </section>
  <section id="requests:\1">
    <title>\1</title>
    <indexterm significance="preferred"><primary>\1</primary></indexterm>

Plus manual editing of the first & last section, and manual
conversion of GrabButton & GrabServer due to extra indexterm lines.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-04 16:14:40 -08:00
Alan Coopersmith
14a0efb08c spec: Fix a bunch of the .RB -> <emphasis> mappings
Cleans up the opening { of enum lists that the closing was handled
by commit 68bf1a7a0c

perl -i -p -e 's{^<emphasis([^>]*)>(\W+?\s+)}{$2<emphasis$1>}g' *.xml

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-04 11:45:48 -08:00
Alan Coopersmith
c11f17ab76 spec: add more indexterms linking into the body of the document
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-04 01:38:10 -08:00
Alan Coopersmith
19ce91d225 spec: move another indexterm in glossary to workaround fop crashing bug
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-04 00:21:36 -08:00
Alan Coopersmith
2406b705e5 spec: Change titles of other specs from emphasis to citetitle tags
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-03 22:09:05 -08:00
Alan Coopersmith
10b0200992 spec: Fix section title markup in Connection Setup chapter
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-03 22:02:06 -08:00
Alan Coopersmith
573cf64807 spec: Fix section title markup in Protocol Formats chapter
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-03 22:01:57 -08:00
Alan Coopersmith
79afc5fb99 spec: convert predefined atom list from table to simplelist
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-03 21:43:09 -08:00
Alan Coopersmith
68bf1a7a0c spec: Fix a bunch of the .BR -> <emphasis> mappings
perl -i -p -e 's{ (\W*?)\s*</emphasis>}{</emphasis>$1}g' *.xml

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-03 16:02:45 -08:00
Gaetan Nadon
eef13837a6 specs: add ServerInterpreted addresses directory
Relocated from xorg-docs/specs/SIAddresses

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-12-02 16:16:26 -05:00
Alan Coopersmith
fb8a596aec spec: Add glossterm cross reference links to glossary
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-11-29 00:23:38 -08:00
Alan Coopersmith
ee6ddb4b0e spec: Stopping marking glossary terms as functions when they're not
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-11-28 23:56:12 -08:00
Alan Coopersmith
710b9979c9 spec: Finish converting some unconverted index entries in glossary
Change made by:
perl -i -p -e 's{\<\!-- \.IN "([^"]+)" "([^"]+)" "\@DEF\@" --\>}{  <indexterm significance="preferred"><primary>$1</primary><secondary>$2</secondary></indexterm>}' glossary.xml

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-11-28 23:52:37 -08:00
Alan Coopersmith
ae571ef20d spec: Add id's to glossary entries for use in cross-reference links
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-11-28 23:35:51 -08:00