[PATCH 0/3] Xserver internals doc patches

Alan Coopersmith alan.coopersmith at oracle.com
Fri May 14 16:45:54 PDT 2010


The recent flurry of ABI changing cleanups reminded me that I've been
meaning for a while to finish the move of the X DDX porting doc which
documents many of those functions from the xorg-docs module to xserver,
so it can be kept in sync with the code it's documenting.

Unfortunately, the xorg-macros definitions for the DocBook XML rules it
uses conflict with the xorg-macros LinuxDoc rules, so first I had to
convert the existing LinuxDoc documents in the xserver tree to DocBook.

Due to the extreme size of these patches (over 1Mb), I've posted the first
two at:
	http://people.freedesktop.org/~alanc/Xserver-docs/

I've also posted there the current resulting DocBook/XML files and the
HTML & Text conversions of those built after applying these patches.

This series is not about fixing the existing docs, just getting them
updated so that everyone can start fixing them & including updates to
them in your ABI changing patches.

There are plenty of things I noticed while doing the LinuxDoc->DocBook
conversion that are already out of date:

 - Instructions for modules to use xf86Version.h & XFree86 Version symbols
 - Drivers needing to use xf86_ansic.h and not include system headers/libraries
 - elfloader
 - The huge RAC section is clearly out of date, but I don't know what to
	put in for libpciaccess instead
 - References to cfb*
 - Some more clockRange vs. clockRanges confusion - haven't checked if
	thats typos or the sillyness ajax recently cleaned up

And then of course, there's the DevPrivates rewrite in progress.

Patches to fix any and all of those are encouraged once these land.

Alan Coopersmith (3):
  Convert LinuxDoc documents to DocBook/XML
  Move Xserver-spec.xml from xorg-docs to doc/xml
  Show Xserver release/version date in DIX & DDX docs

 configure.ac                    |   10 +-
 doc/Makefile.am                 |    2 +
 doc/xml/Makefile.am             |   35 +
 doc/xml/Xserver-spec.xml        | 5182 ++++++++++++++++++++++
 doc/xml/xmlrules.in             |   59 +
 doc/xml/xserver.ent.in          |    3 +
 hw/dmx/doc/Makefile.am          |   35 +-
 hw/dmx/doc/dmx.sgml             | 2777 ------------
 hw/dmx/doc/dmx.xml              | 3447 ++++++++++++++
 hw/dmx/doc/scaled.sgml          |  707 ---
 hw/dmx/doc/scaled.xml           |  725 +++
 hw/xfree86/doc/sgml/DESIGN.sgml | 7414 -------------------------------
 hw/xfree86/doc/sgml/DESIGN.xml  | 9370 +++++++++++++++++++++++++++++++++++++++
 hw/xfree86/doc/sgml/Makefile.am |   39 +-
 14 files changed, 18846 insertions(+), 10959 deletions(-)
 create mode 100644 doc/xml/Makefile.am
 create mode 100644 doc/xml/Xserver-spec.xml
 create mode 100644 doc/xml/xmlrules.in
 create mode 100644 doc/xml/xserver.ent.in
 delete mode 100644 hw/dmx/doc/dmx.sgml
 create mode 100644 hw/dmx/doc/dmx.xml
 delete mode 100644 hw/dmx/doc/scaled.sgml
 create mode 100644 hw/dmx/doc/scaled.xml
 delete mode 100644 hw/xfree86/doc/sgml/DESIGN.sgml
 create mode 100644 hw/xfree86/doc/sgml/DESIGN.xml



More information about the xorg-devel mailing list