[PATCH libX11 1/2] xkb: fix misleading comment about consumed modifiers

Ran Benita ran234 at gmail.com
Tue Feb 3 10:23:49 PST 2015


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 at gmail.com>
---
I made the context big enough to catch the extended (and correct)
description of `mods_rtrn` in XkbTranslateKeyCode.man.

 man/xkb/XkbLookupKeySym.man     | 2 +-
 man/xkb/XkbTranslateKeyCode.man | 2 +-
 specs/XKB/ch12.xml              | 4 ++--
 3 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/man/xkb/XkbLookupKeySym.man b/man/xkb/XkbLookupKeySym.man
index fe9cb13..8a8f0c1 100644
--- a/man/xkb/XkbLookupKeySym.man
+++ b/man/xkb/XkbLookupKeySym.man
@@ -37,21 +37,21 @@ XkbLookupKeySym \- Find the symbol associated with a key for a particular state
 .I \- dpy
 connection to X server
 .TP
 .I \- key
 key for which symbols are to be found
 .TP
 .I \- state
 state for which symbol should be found
 .TP
 .I \- mods_rtrn
-backfilled with unconsumed modifiers
+backfilled with consumed modifiers
 .TP
 .I \- sym_rtrn
 backfilled with symbol associated with key + state
 .SH DESCRIPTION
 .LP
 .I XkbLookupKeySym 
 is the equivalent of the core 
 .I XLookupKeySym 
 function. For the core keyboard, given a keycode 
 .I key 
diff --git a/man/xkb/XkbTranslateKeyCode.man b/man/xkb/XkbTranslateKeyCode.man
index 7f1afdd..e234412 100644
--- a/man/xkb/XkbTranslateKeyCode.man
+++ b/man/xkb/XkbTranslateKeyCode.man
@@ -37,21 +37,21 @@ XkbTranslateKeyCode \-  Translate a keycode to a key symbol and modifiers
 .I \- xkb
 keyboard description to use for translation
 .TP
 .I \- key
 keycode to translate
 .TP
 .I \- mods
 modifiers to apply when translating key
 .TP
 .I \- mods_rtrn
-backfilled with unconsumed modifiers
+backfilled with consumed modifiers
 .TP
 .I \- keysym_rtrn
 keysym resulting from translation
 .SH DESCRIPTION
 .LP
 .I mods_rtrn 
 is backfilled with the modifiers consumed by the translation process. 
 .I mods 
 is a bitwise inclusive OR of the legal modifier masks: ShiftMask, LockMask, 
 ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, Mod4Mask, Mod5Mask.The 
diff --git a/specs/XKB/ch12.xml b/specs/XKB/ch12.xml
index fcfa8f9..0e73698 100644
--- a/specs/XKB/ch12.xml
+++ b/specs/XKB/ch12.xml
@@ -440,21 +440,21 @@ to find the symbol associated with a key for a particular state.
         state for which symbol should be found
       </para>
     </listitem>
   </varlistentry>
   <varlistentry>
     <term>
       <parameter>mods_rtrn</parameter>
     </term>
     <listitem>
       <para>
-        backfilled with unconsumed modifiers
+        backfilled with consumed modifiers
       </para>
     </listitem>
   </varlistentry>
   <varlistentry>
     <term>
       <parameter>sym_rtrn</parameter>
     </term>
     <listitem>
       <para>
         backfilled with symbol associated with key + state
@@ -833,21 +833,21 @@ To translate a keycode to a key symbol and modifiers, use
         modifiers to apply when translating <parameter>key</parameter>
       </para>
     </listitem>
   </varlistentry>
   <varlistentry>
     <term>
       <parameter>mods_rtrn</parameter>
     </term>
     <listitem>
       <para>
-        backfilled with unconsumed modifiers
+        backfilled with consumed modifiers
       </para>
     </listitem>
   </varlistentry>
   <varlistentry>
     <term>
       <parameter>keysym_rtrn</parameter>
     </term>
     <listitem>
       <para>
         keysym resulting from translation
-- 
2.2.2



More information about the xorg-devel mailing list