Commit graph

371 commits

Author SHA1 Message Date
Alan Coopersmith
00dc587c46 spec: fixup quote characters
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:51 -08:00
Alan Coopersmith
dc7c5001c6 spec: give footnotes ids for more stable links
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:51 -08:00
Alan Coopersmith
a87c92dbc5 spec: Convert Data Types section to have a section per type, with tables
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:50 -08:00
Alan Coopersmith
8f36732665 spec: Finish replacing nroff .sp macros with <para> breaks
Mostly just removes the <!-- .sp --> comments where they had already
been autoconverted.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:50 -08:00
Alan Coopersmith
ac94c9a5dd spec: markup data type names with <type>
Automated replacement, followed by manual correction to <structfield>
when names refer to fields in given types/structs.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:50 -08:00
Alan Coopersmith
2a55f651cc spec: Use <superscript> for exponents
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:50 -08:00
Alan Coopersmith
9b3937a0d2 spec: Convert a bunch of AccessContext references from <function> to </type>
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:50 -08:00
Alan Coopersmith
5b71d6320d spec: Use tables for contents of Requests, Events & Errors
Much more consistent layout than previous mix of
blockquotes & literallayouts

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:50 -08:00
Alan Coopersmith
f494b7d137 spec: Use <personname> markup in Acknowledgements
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:50 -08:00
Alan Coopersmith
7cf85b0cdd spec: make links from encoding section to definitions
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:50 -08:00
Alan Coopersmith
c4191141d3 spec: Convert Errors chapter to have a section per request
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:50 -08:00
Alan Coopersmith
067c12183e spec: Convert Events chapter to have a section per request
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:50 -08:00
Alan Coopersmith
7ba1f9d1cc spec: Convert Requests chapter to have a section per request
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:50 -08:00
Alan Coopersmith
3eb7472574 spec: Use <errorname> instead of <function> for error names
Also markup some uses of errornames that were previously missed.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-01-22 09:55:50 -08:00
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
Peter Hutterer
3c1ebd1cfe specs: note that axis values are non-sparse arrays
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2014-01-06 16:11:15 +10:00
Peter Hutterer
06da19e15c specs: clarify SD keyboard focus behaviour
The smart thing would be to have the SD's keyboard focus to be identical to
the MD's keyboard focus (and a BadDevice returned when trying to set an
attached SD's keyboard focus) but alas, the server never implemented this
behaviour and we've now shipped 7 versions with separate SD and MD focus. So
consider this set in stone. oops.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Jasper St. Pierre <jstpierre@mecheye.net>
2014-01-06 16:11:05 +10:00
Alan Coopersmith
24f8010136 Fix length of padding in server reply
Length of "20" with unspecified contents was accidentally split into
a length of "2" and contents of "0" in the docbook conversion.
Verified against old spec in http://www.x.org/docs/Xext/bigreq.pdf

Reported-by: shoop_da_whoop on #xorg-devel IRC
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Reviewed-by: Jasper St. Pierre <jstpierre@mecheye.net>
2013-09-05 17:45:16 -07:00
Daniel Martin
db07706cb2 specs: Change XkbSA_DfltBtnAbsolute to 4
Adopt the value from XKB.h:
    #define XkbSA_DfltBtnAbsolute (1L << 2)

Found-by: Ran Benita <ran234@gmail.com>
Signed-off-by: Daniel Martin <consume.noise@gmail.com>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2013-08-01 14:43:28 +10:00
Peter Hutterer
e93e9d004c specs: removing a device results in a BarrierLeave event
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-12-17 14:24:47 +10:00
Jasper St. Pierre
5f9d3b8584 Add support for pointer barrier events
Signed-off-by: Jasper St. Pierre <jstpierre@mecheye.net>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-12-09 23:35:44 -05:00
Daniel Martin
377efaaa98 specs: XI2: Fix mods in XIPassive(Un)GrabDevice
XIPassiveGrabDevice and XIPassiveUngrabDevice are using lists of
modifier masks. This one corrects these types.

MODIFIERMASK was introduced, because a SETofMODIFIERMASK differs from a
SETofKEYMASK: AnyModifier=(1<<15) vs. GrabAnyModifier=(1U<<31).

Signed-off-by: Daniel Martin <consume.noise@gmail.com>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-11-07 21:47:54 +10:00
Daniel Martin
eb38fd9af8 specs: XI2: Rename AxisClass to ValuatorClass
ValuatorClass is the XI2 term for AxisClass.

Signed-off-by: Daniel Martin <consume.noise@gmail.com>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-11-07 21:47:08 +10:00
Daniel Martin
b30e7221b8 specs: XI2: Fix typos
Signed-off-by: Daniel Martin <consume.noise@gmail.com>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-11-07 21:46:42 +10:00
Peter Hutterer
743cb2cf15 XI2proto: spec formatting fix
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-11-02 15:37:28 +10:00
Ran Benita
a06905c8ef specs: XI2: add titles to requests/events and show them in TOC
You often want to quickly jump to the specification of a specific
request/event, so add them to the table of contents to allow for that.
This also provides the reader with a quick glance at what the protocol
looks like.

Signed-off-by: Ran Benita <ran234@gmail.com>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-10-29 16:31:52 +10:00
Ran Benita
7409807176 specs: XI2: make event/request name formatting consistent
None of the other have ':' there.

Signed-off-by: Ran Benita <ran234@gmail.com>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-10-29 16:31:38 +10:00
Peter Hutterer
3ed8aed321 Fix two typos in spec/comments
The ButtonClass provides the number of buttons, not the lentgh of the mask.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2012-06-14 08:57:32 +10:00
Peter Hutterer
b02b0b42e2 specs: XI 2.2 release date is March 2012
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:04 +10:00
Peter Hutterer
950a7a0b2e specs: Remove work in progress warning
We're close enough to a release now.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:04 +10:00
Peter Hutterer
3ac053f2c7 specs: remove "since" from TouchOwnershipEvent
It's already in a section "Events introduced in version 2.2"

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:04 +10:00
Peter Hutterer
b42e4d24a2 specs: remove TouchOwnership mention from DeviceEvent
TouchOwnership is described separately below.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:04 +10:00
Peter Hutterer
a09ca92ce3 specs: whitespace fix to avoid wrong asciidoc formatting
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:04 +10:00
Peter Hutterer
b1458f6fa9 specs: fix link to touch ownership section
Introduced in 535a4377dd

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:04 +10:00
Peter Hutterer
b321ea46fb specs: GrabtypeTouchBegin was added in XI 2.2
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:04 +10:00
Peter Hutterer
3773e33579 specs: formatting fix, move AcceptTouch and RejectTouch onto their own line
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
2012-03-02 12:05:04 +10:00