doc registers: document prompt history registers

So far they have only been talked about in source code
(HistoryRegister), not in documentation.

Let's give them an official name so users can find them better;
"prompt history register" seems better than "history register" since
the former gives more context. OTOH, in future other registers (like @)
could grow into history registers, so I'm not sure.

State that the history registers are only changed by _interactive_
prompts; that's not quite true yet for user modes but I'll push a
separate fix for that.
This commit is contained in:
Johannes Altmanninger 2022-07-29 21:04:23 +02:00
parent 253b13281e
commit c335712e4e
2 changed files with 10 additions and 4 deletions

View File

@ -15,7 +15,7 @@ released versions.
* User mappings is now bound to `<space>` while keeping/removing main selection * User mappings is now bound to `<space>` while keeping/removing main selection
moved to `,` and `<a-,>` moved to `,` and `<a-,>`
* History registers `%reg{colon}`, `%reg{slash}` and `%reg{pipe}` now * Prompt history registers `%reg{colon}`, `%reg{slash}` and `%reg{pipe}` now
have reverse chronological order have reverse chronological order
== Kakoune 2021.11.07 == Kakoune 2021.11.07

View File

@ -34,7 +34,9 @@ All normal-mode commands using a register default to a specific one if not speci
default search / regex register, used by: default search / regex register, used by:
*/*, *<a-/>*, *?*, *<a-?>*, *n*, *<a-n>*, *N*, *<a-N>*, ***, *<a-*>*, */*, *<a-/>*, *?*, *<a-?>*, *n*, *<a-n>*, *N*, *<a-N>*, ***, *<a-*>*,
*s*, *S*, *<a-k>* and *<a-K>* *s*, *S*, *<a-k>* and *<a-K>*
(see <<keys#searching, `:doc keys searching`>>) (see <<keys#searching, `:doc keys searching`>>).
This is a prompt history register, holding the last 100 commands entered
at an interactive regex prompt.
*@* (arobase):: *@* (arobase)::
default macro register, used by: default macro register, used by:
@ -50,7 +52,10 @@ All normal-mode commands using a register default to a specific one if not speci
*|* (pipe):: *|* (pipe)::
default shell command register, used by commands that spawn a subshell: default shell command register, used by commands that spawn a subshell:
*|*, *<a-|>*, *!* and *<a-!>* *|*, *<a-|>*, *!* and *<a-!>*
(see <<keys#changes-through-external-programs, `:doc keys changes-through-external-programs`>>) (see <<keys#changes-through-external-programs, `:doc keys changes-through-external-programs`>>).
This is a prompt history register, holding the last 100 commands entered
at interactive shell command prompts, except for commands starting with
a space.
== Special registers == Special registers
@ -70,7 +75,8 @@ contain some special data
null register, always empty null register, always empty
*:* (colon):: *:* (colon)::
last entered command prompt history register holding the last 100 commands entered at the
interactive prompt, except for commands starting with a space.
== Integer registers == Integer registers