Commit graph

72 commits

Author SHA1 Message Date
Alan Coopersmith
f3e02cc46a spec: fix boundaries of <function> tags
Conversion from nroff .BR "function" "otherstuff" style markup got
confused in a few places.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:50 -08:00
Alan Coopersmith
8dd500ace7 spec: add autogenerated index
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:49 -08:00
Alan Coopersmith
ea1e8219aa spec: Convert .IN comments to indexterm tags
Performed with:
perl -i -p -e 's{\<\!-- \.IN "([^"]+)" "" "\@DEF\@" --\>}{<indexterm significance="preferred"><primary>$1</primary></indexterm>}' specs/fsproto.xml
perl -i -p -e 's{\<\!-- \.IN "([^"]+)" "([^"]+)" "\@DEF\@" --\>}{  <indexterm significance="preferred"><primary>$1</primary><secondary>$2</secondary></indexterm>}' specs/fsproto.xml

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:49 -08:00
Alan Coopersmith
94a1c39d1a spec: convert list of license models from itemizedlist to variablelist
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:49 -08:00
Alan Coopersmith
f00deaf273 spec: add <acronym> markup
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:49 -08:00
Alan Coopersmith
ecc7f1c816 spec: remove some extra quotes from nroff conversion
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:49 -08:00
Alan Coopersmith
40fa6e3b92 spec: Use <figure> markup for figure labels
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:49 -08:00
Alan Coopersmith
30d9203bd2 spec: add links to references to other sections
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:49 -08:00
Alan Coopersmith
8955b4ea51 spec: change ids for encoding sections from *_2 to Encoding::*
Easier for cross-reference linking, matches what x11proto uses

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:49 -08:00
Alan Coopersmith
c362dc235e spec: fixup markup/formatting of the naming syntax section
Use <replaceable> <literal> <optional> etc. tags instead of
&lt;&gt; "" and [] pairs.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:49 -08:00
Alan Coopersmith
49a6729258 spec: markup introduction of new terms with <firstterm>
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:49 -08:00
Alan Coopersmith
66a3f8e829 spec: convert from article with sections to book with chapters
Matches most other X.Org specs, and restores our chapter numbering
in output

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:49 -08:00
Alan Coopersmith
d0fb589de8 spec: fixup bibliography entries (correct authors, link to references)
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:49 -08:00
Alan Coopersmith
66f98aff9a spec: add olinks to X11 protocol & XLFD specs
Also use <citetitle> to markup titles of other specs/docs.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:49 -08:00
Alan Coopersmith
91dd8f639b spec: Replace ASCII => & -> arrows with Unicode ▶ & ◀
Matches formatting used in core X11 & current extension specs

This spec previously used => for server to client replies, like the
other specs, but also had -> for client responses to server data, so
the opposing direction arrows should make this distinction clearer.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:48 -08:00
Keith Packard
431a426623 Replace 'pointer' with the equivalent 'void *'.
The pointer typedef is being removed because it causes so many
compiler warnings when -Wshadow is enabled.

Signed-off-by: Keith Packard <keithp@keithp.com>
Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
2014-01-22 09:43:48 -08:00
Gaetan Nadon
d84789dc33 config: replace deprecated use of AC_OUTPUT with AC_CONFIG_FILES
Fix Automake warning: AC_OUTPUT should be used without arguments.
www.gnu.org/software/autoconf/manual/autoconf.html#Configuration-Files

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2013-10-26 09:42:05 -04:00
Colin Walters
81e4d4ec53 autogen.sh: Implement GNOME Build API
http://people.gnome.org/~walters/docs/build-api.txt

Signed-off-by: Adam Jackson <ajax@redhat.com>
2013-01-15 14:02:59 -05:00
Adam Jackson
4a7ca1bea4 configure: Remove AM_MAINTAINER_MODE
Signed-off-by: Adam Jackson <ajax@redhat.com>
2013-01-15 14:01:10 -05:00
Alan Coopersmith
607784e2ad fontsproto 2.1.2
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2012-03-22 20:40:21 -07:00
Matt Dew
419c6b31ff 1 - fix the capitolization of the ID attriutes 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>
2011-10-02 20:15:53 -06:00
Gaetan Nadon
5073454c1a specs: use <copyright> for the first holder in multi licensing
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-20 19:48:46 -04:00
Gaetan Nadon
5026754b23 specs: The strandard name is still "X Consortium Standard"
This spec, and libX11 spec, are the only two docs with a different
standard name.

http://cgit.freedesktop.org/xorg/doc/xorg-docs/commit/specs/FSProtocol
?h=XORG-RELEASE-1&id=0f51a88d2cf4a4d1394c79faa3339e5151e5f682

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-19 08:00:38 -04:00
Gaetan Nadon
6817307590 specs: fix multi licensed copyright notice and license text
For documentation having multiple licenses, the copyright and legalnotice
elements sequence cannot instantiated multiple times.
The copyright notice and license text are therefore coded inside a legalnotice
element. The role attribute on the paragraph is used to allow styling of the
copyright notice text which should not be italicized.

To view the change in the html format, obtain xorg-sgml-doctools
at version 1.10.1 or later and rebuild the html version of the spec.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-18 10:28:19 -04:00
Gaetan Nadon
aaf34e37a1 specs: fix author affiliation markup
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-17 20:43:00 -04:00
Gaetan Nadon
ddb83dcf2d docs: use the &fullrelvers; entity to set X11 release information
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-12 20:42:31 -04:00
Gaetan Nadon
a82382dd66 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>
2011-09-12 20:34:47 -04:00
Gaetan Nadon
1be097307a 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:07 -04:00
Gaetan Nadon
0192fbcab2 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
Gaetan Nadon
e437297136 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
c045479c5d 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
Gaetan Nadon
ea8af5fe7f 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
Alan Coopersmith
74a10bb2f4 spec: Fix section titles/nesting
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-16 17:45:23 -08:00
Gaetan Nadon
043885855c 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>
2010-11-09 15:19:09 -05:00
Alan Coopersmith
2fce721a9a fontsproto 2.1.1
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-29 21:29:15 -07:00
Alan Coopersmith
aa59b49bb7 fsproto.xml: Convert ASCII art figures to UTF-8 line drawings
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-29 21:26:13 -07:00
Matt Dew
ddb2392d7a specs: convert protocol fsproto from xorg-docs to DocBook XML
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-08-09 12:18:00 -04:00
Gaetan Nadon
40b8f3e374 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>
2010-03-28 19:25:52 -04:00
Gaetan Nadon
b018907748 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>
2010-03-28 19:00:31 -04:00
Gaetan Nadon
4a85fd6b89 Makefile.am: add ChangeLog and INSTALL on MAINTAINERCLEANFILES
Now that the INSTALL file is generated.
Allows running make maintainer-clean.
2009-11-22 19:24:48 -05:00
Gaetan Nadon
96fe6327d6 README: file created or updated #24206
Contains a set of URLs to freedesktop.org.
2009-11-16 11:13:30 -05:00
Gaetan Nadon
84f5d55eec Makefile.am: ChangeLog not required: EXTRA_DIST or *CLEANFILES #24432
ChangeLog filename is known to Automake and requires no further
coding in the makefile.
2009-11-15 19:45:26 -05:00
Gaetan Nadon
5cd013191e 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
2009-11-15 18:31:28 -05:00
Gaetan Nadon
8bb119d1c7 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.
2009-11-15 18:11:36 -05:00
Gaetan Nadon
b6b91c61fa 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
2009-11-15 13:55:25 -05:00
Gaetan Nadon
ef2976f9b4 .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.
2009-11-15 13:22:55 -05:00
Peter Hutterer
8ce8e2e503 fontsproto 2.1.0
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2009-08-27 16:21:09 +10:00
Peter Hutterer
c2c7f7c5b7 Remove RCS tags
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2009-08-27 16:16:36 +10:00
Paulo Cesar Pereira de Andrade
72c22dd717 Janitor: Correct make distcheck and dont distribute autogen.sh 2009-01-27 20:06:28 -02:00
James Cloos
451d42b3e5 Replace static ChangeLog with dist-hook to generate from git log 2007-12-06 16:39:01 -05:00