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>
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>
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>
"unsigned int width, unsigned int height", not a single parameter "height"
of type "unsignedintwidth,".
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
