summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNoam Postavsky <npostavs@gmail.com>2016-08-06 09:05:05 -0400
committerNoam Postavsky <npostavs@gmail.com>2016-08-06 15:46:18 -0400
commit3c9cb57c6fae57d3798298faecccd0402b4ddd9a (patch)
tree2947c7808521acb3f5744a5e6fe1c8da7cd5017b
parentd841a03c5ee3e9a59a133474601f9bda190ee8fa (diff)
downloademacs-3c9cb57c6fae57d3798298faecccd0402b4ddd9a.tar.gz
Document use of vectors in keymaps
* doc/lispref/keymaps.texi (Format of Keymaps): Mention vector format (Bug #14797).
-rw-r--r--doc/lispref/keymaps.texi17
1 files changed, 13 insertions, 4 deletions
diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi
index f5d3811faed..2641ad0b6aa 100644
--- a/doc/lispref/keymaps.texi
+++ b/doc/lispref/keymaps.texi
@@ -194,10 +194,19 @@ explicitly bound to @code{nil} (see below).
@item @var{char-table}
If an element of a keymap is a char-table, it counts as holding
bindings for all character events with no modifier bits
-(@pxref{modifier bits}): element @var{n} is the binding for the
-character with code @var{n}. This is a compact way to record lots of
-bindings. A keymap with such a char-table is called a @dfn{full
-keymap}. Other keymaps are called @dfn{sparse keymaps}.
+(@pxref{modifier bits}): the element whose index is @var{c} is the
+binding for the character @var{c}. This is a compact way to record
+lots of bindings. A keymap with such a char-table is called a
+@dfn{full keymap}. Other keymaps are called @dfn{sparse keymaps}.
+
+@item @var{vector}
+This kind of element is similar to a char-table: the element whose
+index is @var{c} is the binding for the character @var{c}. Since the
+range of characters that can be bound this way is limited by the
+vector size, and vector creation allocates space for all character
+codes from 0 up, this format should not be used except for creating
+menu keymaps (@pxref{Menu Keymaps}), where the bindings themselves
+don't matter.
@item @var{string}
@cindex keymap prompt string