summaryrefslogtreecommitdiff
path: root/specs
diff options
context:
space:
mode:
authorAlan Coopersmith <alan.coopersmith@oracle.com>2014-07-09 00:03:23 -0700
committerAlan Coopersmith <alan.coopersmith@oracle.com>2014-07-19 13:56:57 -0700
commiteb1453a0c69606b8af96b90ddccf1b93a069fb35 (patch)
tree508a2286d290574352f115abc7a389d4f8d2d328 /specs
parent252d99c87b60ac6f3f2b36f292f9b3880daabe26 (diff)
downloadxorg-lib-libX11-eb1453a0c69606b8af96b90ddccf1b93a069fb35.tar.gz
specs/XKB: Manual fixup of function name markup
Handles typos that caused the scripts to miss matches, functions like malloc & free from other libraries, function name patterns, etc. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Diffstat (limited to 'specs')
-rw-r--r--specs/XKB/ch03.xml22
-rw-r--r--specs/XKB/ch05.xml4
-rw-r--r--specs/XKB/ch06.xml6
-rw-r--r--specs/XKB/ch08.xml8
-rw-r--r--specs/XKB/ch09.xml4
-rw-r--r--specs/XKB/ch10.xml4
-rw-r--r--specs/XKB/ch12.xml2
-rw-r--r--specs/XKB/ch14.xml20
-rw-r--r--specs/XKB/ch15.xml2
-rw-r--r--specs/XKB/ch16.xml4
-rw-r--r--specs/XKB/ch18.xml8
-rw-r--r--specs/XKB/ch20.xml4
-rw-r--r--specs/XKB/ch21.xml4
13 files changed, 46 insertions, 46 deletions
diff --git a/specs/XKB/ch03.xml b/specs/XKB/ch03.xml
index 247a2eca..8ad827f7 100644
--- a/specs/XKB/ch03.xml
+++ b/specs/XKB/ch03.xml
@@ -101,7 +101,7 @@ Call the allocator function with some arbitrary size, as a hint.
<listitem>
<para>
For those arrays that have an
-<emphasis>Xkb...Add...</emphasis>
+<function>Xkb...Add...</function>
function, call it each time you want to add new data to the array. The
function expands the array if necessary.
</para>
@@ -206,16 +206,16 @@ keyboard description has changed, you can determine the set of changes by
passing the event to an Xkb function that "notes" event information in the
corresponding changes data structure. These "note changes" functions are
defined for all major Xkb components, and their names have the form
-<emphasis>XkbNote{Component}Changes</emphasis>,
+<function>XkbNote<replaceable>{Component}</replaceable>Changes</function>,
where
-<emphasis>Component</emphasis>
+<replaceable>Component</replaceable>
is the name of a major Xkb component such as
-<emphasis>Map</emphasis>
+<literal>Map</literal>
or
-<emphasis>Names</emphasis>.
+<literal>Names</literal>.
When you want to copy these changes from the server into a local copy of the
keyboard description, use the corresponding
-<emphasis>XkbGet{Component}Changes</emphasis>
+<function>XkbGet<replaceable>{Component}</replaceable>Changes</function>
function,
passing it the changes structure. The function then retrieves only the changed
structures from the server and copies the modified pieces into the local
@@ -228,18 +228,18 @@ keyboard description.
<para>
For the same reasons you should not directly use
-<emphasis>malloc</emphasis>
+<function>malloc</function>
to allocate Xkb data structures, you should not free Xkb data structures or
components directly using
-<emphasis>free</emphasis>
+<function>free</function>
or
-<emphasis>Xfree</emphasis>.
+<function>Xfree</function>.
Xkb provides functions to free the various data structures and their
components. Always use the free functions supplied by Xkb. There is no
guarantee that any particular field can be safely freed by
-<emphasis>free</emphasis>
+<function>free</function>
or
-<emphasis>Xfree</emphasis>.
+<function>Xfree</function>.
</para>
</sect1>
</chapter>
diff --git a/specs/XKB/ch05.xml b/specs/XKB/ch05.xml
index 2ded1098..0259b710 100644
--- a/specs/XKB/ch05.xml
+++ b/specs/XKB/ch05.xml
@@ -344,7 +344,7 @@ It is a bitwise inclusive OR of the legal modifier masks:
<para>
To lock and unlock any of the eight real keyboard modifiers, use
-<emphasis>XkbLockModifiers:</emphasis>
+<function>XkbLockModifiers</function>:
</para>
<indexterm significance="preferred" zone="XkbLockModifiers"><primary><function>XkbLockModifiers</function></primary></indexterm>
@@ -425,7 +425,7 @@ To lock and unlock any of the eight real keyboard modifiers, use
<para>
To latch and unlatch any of the eight real keyboard modifiers, use
-<emphasis>XkbLatchModifiers:</emphasis>
+<function>XkbLatchModifiers</function>:
</para>
diff --git a/specs/XKB/ch06.xml b/specs/XKB/ch06.xml
index 33f008b4..d7cb06b0 100644
--- a/specs/XKB/ch06.xml
+++ b/specs/XKB/ch06.xml
@@ -197,7 +197,7 @@ fields in the
To retrieve one or more components of a keyboard device description, use
<function>XkbGetKeyboard</function>
(see also
-<emphasis>XkbGetKeyboardbyName</emphasis>
+<function>XkbGetKeyboardByName</function>
).
</para>
@@ -302,9 +302,9 @@ Applications seldom need to directly allocate a keyboard description; calling
scratch, however, use
<function>XkbAllocKeyboard</function>
rather than directly calling
-<emphasis>malloc</emphasis>
+<function>malloc</function>
or
-<emphasis>Xmalloc</emphasis>.
+<function>Xmalloc</function>.
</para>
<indexterm significance="preferred" zone="XkbAllocKeyboard"><primary><function>XkbAllocKeyboard</function></primary></indexterm>
diff --git a/specs/XKB/ch08.xml b/specs/XKB/ch08.xml
index dbd5822f..e6315bb4 100644
--- a/specs/XKB/ch08.xml
+++ b/specs/XKB/ch08.xml
@@ -834,7 +834,7 @@ implementation, uses a mask to specify the indicators. The second method, which
is more suitable for applications concerned with interoperability, uses
indicator names. The correspondence between the indicator name and the bit
position in masks is as follows: one of the parameters returned from
-<emphasis>XkbGetNamedIndicators</emphasis>
+<function>XkbGetNamedIndicator</function>
is an index that is the bit position to use in any function call that requires
a mask of indicator bits, as well as the indicator’s index into the
<structname>XkbIndicatorRec</structname>
@@ -1711,8 +1711,8 @@ If any bits are set in the
<para>
-<emphasis>XkbChangeIndicator</emphasis>
-s can generate
+<function>XkbChangeIndicators</function>
+ can generate
<errorname>BadAtom</errorname>
and
<errorname>BadImplementation</errorname>
@@ -1993,7 +1993,7 @@ If the
allocates and initializes it. To free the
<structfield>indicators</structfield>
field, use
-<emphasis>XkbFreeIndicators</emphasis>
+<function>XkbFreeIndicatorMaps</function>
(see <link linkend="Allocating_and_Freeing_Indicator_Maps">section 8.6</link>).
</para>
diff --git a/specs/XKB/ch09.xml b/specs/XKB/ch09.xml
index 99c7fa0e..f0b60dbd 100644
--- a/specs/XKB/ch09.xml
+++ b/specs/XKB/ch09.xml
@@ -454,9 +454,9 @@ Note that
<para>
To determine the current feedback settings of an extension input device, use
-<emphasis>XGetFeedbackControl</emphasis>.
+<function>XGetFeedbackControl</function>.
See the X input extension documentation for more information on
-<emphasis>XGetFeedbackControl</emphasis>
+<function>XGetFeedbackControl</function>
and related data structures.
</para>
diff --git a/specs/XKB/ch10.xml b/specs/XKB/ch10.xml
index c4af77f6..d3e98f94 100644
--- a/specs/XKB/ch10.xml
+++ b/specs/XKB/ch10.xml
@@ -2398,7 +2398,7 @@ Specifying a value of
for the
<parameter>delay</parameter>
parameter causes
-<emphasis>XkbSetSlowKeys</emphasis>
+<function>XkbSetSlowKeysDelay</function>
to generate a
<errorname>BadValue</errorname>
protocol error. If a compatible version of the Xkb extension is not available
@@ -5118,7 +5118,7 @@ To free memory used by the
member of an
<structname>XkbDescRec</structname>
structure, use
-<emphasis>XkbFreeControls:</emphasis>
+<function>XkbFreeControls</function>:
</para>
diff --git a/specs/XKB/ch12.xml b/specs/XKB/ch12.xml
index a769d51b..05506340 100644
--- a/specs/XKB/ch12.xml
+++ b/specs/XKB/ch12.xml
@@ -482,7 +482,7 @@ The
Use
<function>XkbLookupKeyBinding</function>
to find the string bound to a key by
-<emphasis>XRebindKeySym</emphasis>.
+<function>XRebindKeysym</function>.
<function>XkbLookupKeyBinding</function>
is the equivalent of the core
<function>XLookupString</function>
diff --git a/specs/XKB/ch14.xml b/specs/XKB/ch14.xml
index eb756729..0c7cabe7 100644
--- a/specs/XKB/ch14.xml
+++ b/specs/XKB/ch14.xml
@@ -405,7 +405,7 @@ information on these functions.
<entry>
<para><function>XkbGetKeySyms</function></para>
<para><function>XkbResizeKeySyms</function></para>
- <para><emphasis>XkbChangeTypes&#xAD;OfKey</emphasis></para>
+ <para><function>XkbChangeTypes&#xAD;OfKey</function></para>
</entry>
<entry>15.3</entry>
</row>
@@ -414,7 +414,7 @@ information on these functions.
<entry>(1&lt;&lt;2)</entry>
<entry>client</entry>
<entry><structfield>modmap</structfield></entry>
- <entry><emphasis>XkbGetKeyModifier&#xAD;Map</emphasis></entry>
+ <entry><function>XkbGetKeyModifier&#xAD;Map</function></entry>
<entry>15.4</entry>
</row>
<row>
@@ -422,7 +422,7 @@ information on these functions.
<entry>(1&lt;&lt;3)</entry>
<entry>server</entry>
<entry><structfield>explicit</structfield></entry>
- <entry><emphasis>XkbGetKeyExplicit&#xAD;Components</emphasis></entry>
+ <entry><function>XkbGetKeyExplicit&#xAD;Components</function></entry>
<entry>16.3</entry>
</row>
<row>
@@ -437,7 +437,7 @@ information on these functions.
</entry>
<entry>
<para><function>XkbGetKeyActions</function></para>
- <para><emphasis>XkbResizeKey&#xAD;Actions</emphasis></para>
+ <para><function>XkbResizeKey&#xAD;Actions</function></para>
</entry>
<entry>16.1</entry>
</row>
@@ -446,7 +446,7 @@ information on these functions.
<entry>(1&lt;&lt;5)</entry>
<entry>server</entry>
<entry><structfield>behaviors</structfield></entry>
- <entry><emphasis>XkbGetKey&#xAD;Behaviors</emphasis></entry>
+ <entry><function>XkbGetKey&#xAD;Behaviors</function></entry>
<entry>16.2</entry>
</row>
<row>
@@ -462,7 +462,7 @@ information on these functions.
<entry>(1&lt;&lt;7)</entry>
<entry>server</entry>
<entry><structfield>vmodmap</structfield></entry>
- <entry><emphasis>XkbGetVirtualMod&#xAD;Map</emphasis></entry>
+ <entry><function>XkbGetVirtualMod&#xAD;Map</function></entry>
<entry>16.4</entry>
</row>
</tbody>
@@ -1083,9 +1083,9 @@ allocate client and server maps.
If you change the number of key types or construct map components without
loading the necessary components from the X server, do not allocate any map
components directly using
-<emphasis>malloc</emphasis>
+<function>malloc</function>
or
-<emphasis>Xmalloc</emphasis>.
+<function>Xmalloc</function>.
Instead, use the Xkb allocators,
<function>XkbAllocClientMap</function>,
and
@@ -1099,9 +1099,9 @@ Similarly, use the Xkb destructors,
and
<function>XkbFreeServerMap</function>
instead of
-<emphasis>free</emphasis>
+<function>free</function>
or
-<emphasis>Xfree</emphasis>.
+<function>Xfree</function>.
</para>
diff --git a/specs/XKB/ch15.xml b/specs/XKB/ch15.xml
index f798173c..65ce32d0 100644
--- a/specs/XKB/ch15.xml
+++ b/specs/XKB/ch15.xml
@@ -2622,7 +2622,7 @@ description, use
It waits for a reply and places the results in the
<parameter>xkb</parameter>
-&gt;map-&gt;modmap array. If successful,
-<emphasis>XkbGetKeyModifier</emphasis>
+<function>XkbGetKeyModifierMap</function>
returns
<symbol>Success</symbol>.
</para>
diff --git a/specs/XKB/ch16.xml b/specs/XKB/ch16.xml
index fd12a62e..26698bc8 100644
--- a/specs/XKB/ch16.xml
+++ b/specs/XKB/ch16.xml
@@ -3825,7 +3825,7 @@ If any allocation errors occur,
<para>
To change the number of actions bound to a key, use
-<emphasis>XkbResizeKeyAction</emphasis>.
+<function>XkbResizeKeyActions</function>.
</para>
<indexterm significance="preferred" zone="XkbResizeKeyActions"><primary><function>XkbResizeKeyActions</function></primary></indexterm>
@@ -4777,7 +4777,7 @@ To obtain the virtual modifier map (the
</variablelist>
<para>
-<emphasis>XkbGetKeyVirutalModmap</emphasis>
+<function>XkbGetKeyVirtualModmap</function>
sends a request to the server to obtain the virtual modifier mappings for
<parameter>num</parameter>
keys on the keyboard starting with key
diff --git a/specs/XKB/ch18.xml b/specs/XKB/ch18.xml
index 3c927b69..8a490166 100644
--- a/specs/XKB/ch18.xml
+++ b/specs/XKB/ch18.xml
@@ -1053,7 +1053,7 @@ results into the
<para>
-<emphasis>XkbGetNamesChanges</emphasis>
+<function>XkbGetNameChanges</function>
can generate
<errorname>BadAlloc</errorname>,
<errorname>BadImplementation</errorname>,
@@ -1070,9 +1070,9 @@ results into the
<para>
Most applications do not need to directly allocate symbolic names structures.
Do not allocate a names structure directly using
-<emphasis>malloc</emphasis>
+<function>malloc</function>
or
-<emphasis>Xmalloc</emphasis>
+<function>Xmalloc</function>
if your application changes the number of key aliases or radio groups or
constructs a symbolic names structure without loading the necessary components
from the X server. Instead use
@@ -1152,7 +1152,7 @@ The
<para>
Do not free symbolic names structures directly using
-<emphasis>free</emphasis>
+<function>free</function>
or
<function>XFree</function>.
Use
diff --git a/specs/XKB/ch20.xml b/specs/XKB/ch20.xml
index 580f986c..6b58fceb 100644
--- a/specs/XKB/ch20.xml
+++ b/specs/XKB/ch20.xml
@@ -294,9 +294,9 @@ The component name patterns used to describe the request are passed to
structure. This structure has no special allocation constraints or
interrelationships with other structures; allocate and free this structure
using standard
-<emphasis>malloc</emphasis>
+<function>malloc</function>
and
-<emphasis>free</emphasis>
+<function>free</function>
calls or their equivalent:
</para>
diff --git a/specs/XKB/ch21.xml b/specs/XKB/ch21.xml
index e9518526..b26fe246 100644
--- a/specs/XKB/ch21.xml
+++ b/specs/XKB/ch21.xml
@@ -1228,13 +1228,13 @@ To allocate additional space for button actions in an
</variablelist>
<para>
-<emphasis>XkbResizeDeviceButton</emphasis>
+<function>XkbResizeDeviceButtonActions</function>
reallocates space, if necessary, to make sure there is room for a total of
<parameter>new_total</parameter>
button actions in the
<parameter>device_info</parameter>
structure. Any new entries allocated are zeroed. If successful,
-<emphasis>XkbResizeDeviceButton</emphasis>
+<function>XkbResizeDeviceButtonActions</function>
returns Success. If new_total is zero, all button actions are deleted,
<parameter>device_info</parameter>
-&gt;