Add xkb_map_mod_mask_remove_consumed

[platform/upstream/libxkbcommon.git] / README

diff --git a/README b/README
index e9d6aba..5f2d57c 100644 (file)
--- a/README
+++ b/README
@@ -4,10 +4,10 @@ xkbcommon
 libxkbcommon is a keymap compiler and support library which processes a
 reduced subset of keymaps as defined by the XKB specification.  Primarily,
 a keymap is created from a set of Rules/Model/Layout/Variant/Options names,
-processed through an XKB ruleset, and compiled into a struct xkb_desc, which
-is the base type for all xkbcommon operations.
+processed through an XKB ruleset, and compiled into a struct xkb_keymap,
+which is the base type for all xkbcommon operations.
 
-From an xkb_desc, an xkb_state object is created which holds the current
+From an xkb_keymap, an xkb_state object is created which holds the current
 state of all modifiers, groups, LEDs, etc, relating to that keymap.  All
 key events must be fed into the xkb_state object using xkb_state_update_key.
 Once this is done, the xkb_state object will be properly updated, and the
@@ -79,6 +79,9 @@ Notable removals:
       + completely unused in current keymaps, never fully implemented
     - overlays
       + almost completely unused in current keymaps
+    - key behaviors
+      + used to implement radio groups and overlays, and to deal with things
+        like keys that physically lock; unused in current keymaps
     - indicator behaviours such as LED-controls-key
       + the only supported LED behaviour is key-controls-LED; again this
         was never really used in current keymaps