Commit graph

207 commits

Author SHA1 Message Date
Alan Coopersmith
8b77c86a06 Strip trailing whitespace from source files
Performed with: `git ls-files | xargs perl -i -p -e 's{[ \t]+$}{}'`

`git diff -w` & `git diff -b` show no diffs from this change

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Part-of: <https://gitlab.freedesktop.org/xorg/lib/libx11/-/merge_requests/287>
2025-08-02 18:38:26 -07:00
Alan Coopersmith
44f908d928 docs: fix names for XkbKeyKeyType & XkbKeyKeyTypeIndex
Implementation had "Key" twice in these macro names,
but the docs had only listed it once.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 15:27:48 -07:00
Alan Coopersmith
7b16c55063 docs: remove XkbKeySymsOffset
This function was documented but never implemented.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 15:27:48 -07:00
Alan Coopersmith
41a157dfee docs: remove XkbGetNameChanges
This function was documented but never implemented.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 15:27:48 -07:00
Alan Coopersmith
3442a8cee2 docs: remove XkbChangeIndicators and Xkb{Get,Note}IndicatorChanges
These functions were documented but never implemented.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 15:27:13 -07:00
Alan Coopersmith
b7a15d6c6e docs: XkbSAActionSetCtrls is really named XkbActionSetCtrls
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 14:31:20 -07:00
Alan Coopersmith
a1d8dd7267 docs: remove XkbGetStickyKeysOptions & XkbSetStickyKeysOptions
These functions were documented but never implemented.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 14:18:32 -07:00
Alan Coopersmith
bf13f19740 docs: remove XkbGetSlowKeysDelay & XkbSetSlowKeysDelay
These functions were documented but never implemented.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 14:09:35 -07:00
Alan Coopersmith
caab7321d2 docs: remove XkbGetAccessXTimeout & XkbSetAccessXTimeout
These functions were documented but never implemented.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 14:04:15 -07:00
Alan Coopersmith
843e89bd24 docs: remove XkbAllocDeviceLedInfo
This function was documented but never implemented.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 12:58:47 -07:00
Alan Coopersmith
2686dd7a9d docs: finish removing XkbGetBounceKeysDelay & XkbSetBounceKeysDelay
These functions were documented but never implemented.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2023-08-20 12:41:42 -07:00
Po Lu
1294bfa487 specs: document change in XIMPreeditCallbacks
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2022-11-03 14:47:19 -07:00
Alan Coopersmith
a04b84f0f7 Copyright & license cleanup 2022-11-03 20:31:31 +00:00
Benno Schulenberg
da330a1644 docs: unwrap some mistakenly wrapped lines, and correct a comment
The wrapped lines messed up the table.  Also, add some blank lines
to make the table more readable.

Elsewhere, add spaces around an operator (for consistency),
and correct a copy-paste error.

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
2022-01-14 17:19:37 +00:00
Hodong
b7d724df61 specs/XIM: fix a missing "EXT" in the documentation
There was an "EXT" in the original text, but it seems to be missing.

See: 4e66da0783/specs/XIM/xim.ms (L693)

Signed-off-by: Hodong Kim <hodong@nimfsoft.com>
2022-01-07 10:41:15 +00:00
Alan Coopersmith
c1710589bb specs/XIM: Fix "encording" typos
Fixes: #145

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2021-12-07 08:29:43 -08:00
Alan Coopersmith
2b7598221d Fix spelling/wording issues
Found by using:
    codespell --builtin clear,rare,usage,informal,code,names

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2020-07-22 15:19:58 -07:00
Alan Coopersmith
38ec04de7e specs/XKB: Fix misprint in documentation of XkbFreeGeomOverlayKeys()
Fixes: https://gitlab.freedesktop.org/xorg/lib/libx11/issues/86
aka: https://bugs.freedesktop.org/show_bug.cgi?id=23550

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-23 11:43:51 -08:00
Alan Coopersmith
74f2f26811 specs/XKB: Fix misprint in documentation of XkbAllocGeomOverlayKeys()
Fixes: https://gitlab.freedesktop.org/xorg/lib/libx11/issues/85
aka: https://bugs.freedesktop.org/show_bug.cgi?id=23549

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-23 11:43:51 -08:00
Alan Coopersmith
66b039a416 specs/XKB: Fix misprint in documentation of XkbAllocGeomOverlayRows()
Fixes: https://gitlab.freedesktop.org/xorg/lib/libx11/issues/84
aka: https://bugs.freedesktop.org/show_bug.cgi?id=23548

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-23 11:43:51 -08:00
Alan Coopersmith
cdea0e8403 specs/XKB: Fix misprint in documentation of XkbGetNamedGeometry()
Fixes: https://gitlab.freedesktop.org/xorg/lib/libx11/issues/82
aka: https://bugs.freedesktop.org/show_bug.cgi?id=23520

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2019-02-23 11:43:51 -08:00
Alan Coopersmith
d7e22252d6 Remove documentation of obsolete B16 & B32 tags in specs/libX11
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2018-11-10 13:30:47 -08:00
Alan Coopersmith
b856d5d929 Clarify state parameter to XkbSetNamedDeviceIndicator
Checking a Bool to see if it's NULL does not work well in C.
Also reported in https://bugs.freedesktop.org/show_bug.cgi?id=251

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Reviewed-by: Adam Jackson <ajax@redhat.com>
2017-03-24 15:19:27 -07:00
Alan Coopersmith
c6dadd4ceb Make Xkb{Get,Set}NamedIndicator spec & manpages match code
The XKB Library spec and the man pages for XkbGetNamedIndicator &
XkbSetNamedIndicator included a device_spec argument neither function
takes, and do not include the XkbGetNamedDeviceIndicator &
XkbSetNamedDeviceIndicator variants that do take it (along with two
other arguments).

This updates them to match the interfaces the code has provided for
decades.

This has been reported multiple times, so this fixes:
https://bugs.freedesktop.org/show_bug.cgi?id=251
https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=729812
Sun Bug 4528016 XkbSetNamedIndicator & XkbGetNamedIndicator man pages are wrong
  (filed: alan.coopersmith@sun.com 2001-11-15 - now aka Oracle bug 15087506)
X.Org Group Defect Id #9418

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Reviewed-by: Adam Jackson <ajax@redhat.com>
2017-03-24 15:19:18 -07:00
Alan Coopersmith
663f47075f specs/libX11: Update Portability Considerations for the 21st century
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-01-03 08:50:52 +10:00
Alan Coopersmith
28f4b989b5 specs/libX11: Fix broken synopsis for Data/Data16/Data32
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2017-01-01 20:39:53 -08:00
Alan Coopersmith
382561951e specs/libX11: Add missing parameter types for XGetWindowProperty()
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2017-01-01 20:31:54 -08:00
Alan Coopersmith
2beaecdb66 specs/libX11: Make paramdef spacing more consistent
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2017-01-01 20:20:32 -08:00
Alan Coopersmith
4c436c6c14 specs/libX11: Fix paramdef entries listing multiple parameters
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2017-01-01 20:13:29 -08:00
Alan Coopersmith
1728b1a8a4 specs/libX11: More synopsis fixes
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>
2017-01-01 19:46:31 -08:00
Lucien Gentis
f0dc83db7e Typos in "Xlib - C Language X Interface" document - Chapter 02
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>
2017-01-01 17:11:02 -08:00
Matthew D. Fuller
83adf3d1e3 Fixup param specification for XChangeProperty()
Signed-off-by: Matthew D. Fuller <fullermd@over-yonder.net>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2016-06-06 09:44:18 +10:00
Ran Benita
129f13f385 xkb: fix misleading comment about consumed modifiers
In the spec and the man page the `mods_rtrn` argument is described as
"backfilled with unconsumed modifiers" but actually it is backfilled
with the *consumed* modifiers. This is also mentioned a few lines below
in each case.

Signed-off-by: Ran Benita <ran234@gmail.com>
Signed-off-by: James Cloos <cloos@jhcloos.com>
2015-02-05 17:35:57 -05:00
Alan Coopersmith
0885cad1e4 specs/XKB: Markup fractions as <{super,sub}script> instead of <emphasis>
Matches the way they were styled in original doc, before conversion
to DocBook.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-20 09:21:24 -07:00
Alan Coopersmith
d0a9e9d56b specs/XKB: acknowledge my contributions
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 23:55:47 -07:00
Alan Coopersmith
9c0be82017 specs/XKB: Trim leading spaces off text lines
perl -i -p -e 's{/\*(\S)}{/* \1}g;' *.xml

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 23:55:38 -07:00
Alan Coopersmith
75b0b10990 specs/XKB: Add olinks to libX11 for "X Library Functions Affected by Xkb"
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 23:51:06 -07:00
Alan Coopersmith
5009621799 specs/XKB: Fix miscelleanous typos & spelling errors
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 23:51:06 -07:00
Alan Coopersmith
ac219bf152 specs/XKB: add some more indexterms by hand
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 23:51:06 -07:00
Alan Coopersmith
5c3aa4c69e specs/XKB: fixup various formatting issues in <programlisting>s
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 23:51:05 -07:00
Alan Coopersmith
70c648ff85 specs/XKB: fixup various formatting issues in <literallayout>s
Including translating some that are really just lists into
<simplelist> markup.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 20:19:44 -07:00
Alan Coopersmith
94b5677478 specs/XKB: add some more links by hand
random bits where a link looked handy

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 20:19:44 -07:00
Alan Coopersmith
7a15a934cd specs/XKB: add links for terms in definition list under figure 1.1
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 20:19:43 -07:00
Alan Coopersmith
92b86fc3c5 specs/XKB: add links to more tables listing section references
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 20:19:43 -07:00
Alan Coopersmith
06a4483a05 specs/XKB: Table 4.1: remove page numbers & unnecessary para tags
Page numbers refer to old doc format, didn't translate to new one

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 20:19:43 -07:00
Alan Coopersmith
61bd55c6d1 specs/XKB: remove unwanted white space around C -&gt; struct references
perl -i -0 -p -e 's{\s*-&gt;\s*}{-&gt;}g' *xml

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 20:19:42 -07:00
Alan Coopersmith
2be0cc0b2a specs/XKB: replace -&gt; with &rarr; when used as arrow, not in C structs
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 20:18:57 -07:00
Alan Coopersmith
bf1f3d6f6f specs/XKB: replace =&gt; with &rArr; for double arrows
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 20:18:56 -07:00
Alan Coopersmith
c7ee427fc0 specs/XKB: Markup some ranges with &ndash; instead of - 2014-07-19 20:18:56 -07:00
Alan Coopersmith
ec4075303c specs/XKB: Markup some subtractions with &minus; instead of -
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 20:18:56 -07:00