summaryrefslogtreecommitdiff
path: root/specs/libX11
Commit message (Collapse)AuthorAgeFilesLines
* specs: document change in XIMPreeditCallbacksPo Lu2022-11-031-1/+5
| | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* Fix spelling/wording issuesAlan Coopersmith2020-07-224-5/+5
| | | | | | | Found by using: codespell --builtin clear,rare,usage,informal,code,names Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* Remove documentation of obsolete B16 & B32 tags in specs/libX11Alan Coopersmith2018-11-101-17/+6
| | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* specs/libX11: Update Portability Considerations for the 21st centuryAlan Coopersmith2017-01-031-6/+15
| | | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com> Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* specs/libX11: Fix broken synopsis for Data/Data16/Data32Alan Coopersmith2017-01-011-4/+17
| | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* specs/libX11: Add missing parameter types for XGetWindowProperty()Alan Coopersmith2017-01-011-12/+12
| | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* specs/libX11: Make paramdef spacing more consistentAlan Coopersmith2017-01-0116-1798/+1798
| | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* specs/libX11: Fix paramdef entries listing multiple parametersAlan Coopersmith2017-01-0111-71/+150
| | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* specs/libX11: More synopsis fixesAlan Coopersmith2017-01-015-202/+414
| | | | | | | Mostly transforming macro definitions and functions taking void arguments from undecorated <para> tags to use <funcsynopsis> tags to get decorations. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* Typos in "Xlib - C Language X Interface" document - Chapter 02Lucien Gentis2017-01-011-24/+15
| | | | | | | | This patch fixes typos and lack of tags in "Xlib - C Language X Interface" document - Chapter 02. Signed-off-by: Lucien Gentis <lucien.gentis@waika9.com> Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com> Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* Fixup param specification for XChangeProperty()Matthew D. Fuller2016-06-061-1/+2
| | | | | Signed-off-by: Matthew D. Fuller <fullermd@over-yonder.net> Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
* specs/libX11: disengender a user referenceAlan Coopersmith2014-07-181-1/+1
| | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* specs/libX11: Correct value of IconicState to match Xutil.hAlan Coopersmith2014-07-181-1/+1
| | | | | | | | | Xutil.h has always had a value of 3 for IconicState, since 2 was previously used for the long-obsolete ZoomState, so make the spec match what programs have used for decades. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com> Reviewed-by: Matthieu Herrb <matthieu@herrb.eu>
* specs/libX11: Add missing spaces to 'unsignedint' & 'unsignedlong' typesAlan Coopersmith2014-07-0611-75/+75
| | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* specs/libX11: Fix height & width in parameter lists to be two separate entriesAlan Coopersmith2014-07-068-33/+66
| | | | | | | "unsigned int width, unsigned int height", not a single parameter "height" of type "unsignedintwidth,". Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* specs/libX11: Fix x & y in parameter lists to be two separate parametersAlan Coopersmith2014-07-065-26/+52
| | | | | | "int x, int y" not a single parameter y of type "intx" Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* libX11: check size of GetReqExtra after XFlushKees Cook2013-07-221-1/+3
| | | | | | | | | | | | | | | | | | | | | | Two users of GetReqExtra pass arbitrarily sized allocations from the caller (ModMap and Host). Adjust _XGetRequest() (called by the GetReqExtra macro) to double-check the requested length and invalidate "req" when this happens. Users of GetReqExtra passing lengths greater than the Xlib buffer size (normally 16K) must check "req" and fail gracefully instead of crashing. Any callers of GetReqExtra that do not check "req" for NULL will experience this change, in the pathological case, as a NULL dereference instead of a buffer overflow. This is an improvement, but the documentation for GetReqExtra has been updated to reflect the need to check the value of "req" after the call. Bug that manifested the problem: https://bugs.launchpad.net/ubuntu/+source/x11-xserver-utils/+bug/792628 Signed-off-by: Kees Cook <kees@outflux.net> Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com> Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* troff macro expansion in specs/libX11Alan Coopersmith2013-06-0714-376/+232
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Many of the custom nroff macros (.ds <macro> <contents>) were left unsubstituted in the nroff->docbook conversion. This substitution is now performed, via the following perl script: #! /usr/bin/perl -w -i use Text::Wrap; while ($_ = <>) { while ($_ =~ m/\((\w+)\b/g) { my $m = $1; if (exists $macro{$m}) { $_ =~ s/\($m/$macro{$m}/; $_ = wrap('', '', $_); $_ =~ s/[ \t]+$//; } } if ($_ =~ /\<!-- .ds (\w+) (.*) -->/) { my ($m, $s) = ($1, $2); $macro{$m} = $s; while ($macro{$m} =~ /\\\s*$/) { $macro{$m} =~ s/\\\s*$//ms; $macro{$m} .= <>; chomp($macro{$m}); } $macro{$m} =~ s/\\ / /g; } else { print $_; } } Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* specs/libX11: correct prototype for XListPixmapFormats/XImageByteOrderAlan Coopersmith2013-06-071-6/+3
| | | | | | | | | | The XListPixmapFormats arguments was being shown with XImageByteOrder's name and return types. Appears to have been a glitch in the nroff -> docbook conversion. Reported-by: ZHANG Zhaolong <zhangzl2013@126.com> Reviewed-by: Jamey Sharp <jamey@minilop.net> Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* libX11 spec: Correct prototype for XConvertSelectionAlan Coopersmith2012-06-061-1/+2
| | | | | | selection & target parameters were accidentally run together Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* Add X11R7 sections to the libX11 & XKBlib credits to cover Docbook conversionAlan Coopersmith2012-04-171-0/+10
| | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* Add olinks from libX11 & localedb specs to ICCCM specAlan Coopersmith2012-04-173-5/+5
| | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* Add olinks from libX11 spec to ICCCM specAlan Coopersmith2012-04-178-14/+19
| | | | | | Also convert ICCCM title mentions from <emphasis> to <citetitle> Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* libX11 AppC: Fix section headers that didn't translate from nroff properlyAlan Coopersmith2012-04-171-40/+54
| | | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net>
* Add olinks from libX11 spec to x11protocol specAlan Coopersmith2012-04-173-3/+6
| | | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com> Acked-by: Peter Hutterer <peter.hutterer@who-t.net>
* libX11 spec: Remove .br nroff macro left behind in XGetWindowProperty prototypeAlan Coopersmith2012-04-141-1/+1
| | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* informaltable & table cleanupMatt Dew2012-01-219-234/+276
| | | | | | | | | | | | | | | | On certain tables, add top and bottom borders to table header and a bottom border to the table. This matches what those tables in the old pdfs looked like. the <?dbfo keep-together='always'> prevents tables from splitting across pages. Useful for tiny tables. Converting the colwidth to a floating point, IE, 1* -> 1.0* cleans up these build errors: WARNING: table-layout="fixed" and column-width unspecified => falling back to proportional-column-width(1) Signed-off-by: Matt Dew <marcoz@osource.org>
* Cleanup IDs and links in docMatt Dew2011-10-0722-3374/+3356
| | | | | | | | | | 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>
* libX11 specs: use <copyright> for first holder of multi licenseGaetan Nadon2011-09-201-7/+8
| | | | Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
* specs: fix The Open Group license textGaetan Nadon2011-09-191-7/+6
| | | | | | The warranty referred to the X Consortium Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
* specs: The strandard name is still "X Consortium Standard"Gaetan Nadon2011-09-191-1/+1
| | | | | | | This spec, and fsproto spec, are the only two docs with a different standard name. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
* specs: support multi licensed copyright notice and license textGaetan Nadon2011-09-181-6/+2
| | | | | | | | | | 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. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
* specs: handle multiple sets of copyright notice/license/warrantyGaetan Nadon2011-09-171-8/+6
| | | | | | | | | | | | | | | | Docbook groups all the <copyright> elements together and all the <legalnotice> elements together. We cannot have a sequence: <copyright> <legalnotice> <copyright> <legalnotice> [...] A workaround, which was done in some documents, is to put the copyright notice inside the legalnotice in plain text without the <copyright> element. A formal paragraph title is added here which makes the copyright notice bold, and makes it much easier to locate. Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com> Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
* docs: use the &fullrelvers; entity to set X11 release informationGaetan Nadon2011-09-111-2/+6
| | | | Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
* docs: remove orphan <affiliation>Gaetan Nadon2011-09-111-2/+0
| | | | | | | Somehow created during the conversion from roff. Unable to locate the author to which it belongs. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
* docs: remove <productnumber> which is not used by defaultGaetan Nadon2011-09-111-1/+0
| | | | | | | | 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>
* libX11 specs: review doclifter generated tablesGaetan Nadon2011-08-199-274/+192
| | | | | | | | Many tables had a questionnable layout and some had information dropped. Each table was cross-referenced with a pre-docbook version to ensure semantic integrity. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
* credits.xml: remove toc from AcknowledgmentsGaetan Nadon2011-08-191-8/+8
| | | | | | | | | There should be no toc for a simple preface with only one Acknowledgments section. Use <simplesect> markup rather than sect1. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
* libX11 specs: move </para> above <varaiablelist>Gaetan Nadon2011-08-1915-463/+408
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Many, but not all, function synopsis have a paragraph that nests the variable list. The code was generated by doclifter and there is no apprent reasons as to why it was done this way. Found while investigating a spacing issue. Before the patch: <para>Some blurb about the function <funcsynopsis> </funcsynopsis> <variablelist> </variablelist> </para> After the patch: <para>Some blurb about the function</para> <funcsynopsis> </funcsynopsis> <variablelist> </variablelist> There are no noticable differences when reading the doc other than than the removed few pixels of spacing between the function sysnopsis and the variable list block. In some cases, there are no "blurb about the fucntion" and the empty paragraph is removed. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
* Add id attributes to error codes to allow linking from other docs.Matt Dew2011-07-171-17/+17
| | | | | | Signed-off-by: Matt Dew <marcoz@osource.org> Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com> Acked-by: Gaetan Nadon <memsize@videotron.ca>
* specs/libX11: Turn appendix references into linksAlan Coopersmith2011-06-072-2/+2
| | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* specs/libX11: Turn chapter references into linksAlan Coopersmith2011-06-078-16/+26
| | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* specs/libX11: Turn many "see section ..." into linksAlan Coopersmith2011-06-0716-76/+124
| | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* specs/libX11: Convert some header filenames to filename tagsAlan Coopersmith2011-06-053-20/+20
| | | | | | perl -i -p -e 's{^&lt;(.*\.h)&gt;\ *}{<filename class="headerfile">&lt;\1&gt;</filename>}' *.xml Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* Bug 37624 - parameter x is missing from synopsis of XDrawString in libX11.htmlAlan Coopersmith2011-05-271-1/+2
| | | | | | https://bugs.freedesktop.org/show_bug.cgi?id=37624 Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* Add id's to functions, to make clickable links.Matt Dew2011-05-2416-584/+584
| | | | | Signed-off-by: Matt Dew <marcoz@osource.org> Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
* libX11 spec: fix monospaced column alignment after deligaturizationAlan Coopersmith2011-05-201-1/+1
| | | | Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
* Expand latin ligatures out to their NFKC equivalents.James Cloos2011-05-207-15/+15
| | | | | | | | Ligatures should be done by the typesetting system. Manuscripts should not bother with them. Signed-off-by: James Cloos <cloos@jhcloos.com> Reviewed-by: Keith Packard <keithp@keithp.com>
* Remove misplaced hyphens in libX11 DocBook/XML #37364Gaetan Nadon2011-05-205-35/+34
| | | | | | | Reported-by: Christopher Yeleighton <giecrilj@stegny.2a.pl> Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net> Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com> Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
* specs/libX11: Fix XOpenDisplay() prototype in chapter 2 [bug 36244]Alan Coopersmith2011-04-181-11/+6
| | | | | | | | Was incorrectly showing AllPlanes() instead when describing XOpenDisplay() https://bugs.freedesktop.org/show_bug.cgi?id=36244 Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>