summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMaxime Coste <mawww@kakoune.org>2019-10-16 20:19:43 +1100
committerMaxime Coste <mawww@kakoune.org>2019-10-16 20:45:53 +1100
commite4fb70ebec80edcd17f0e00823780e4798a3fb1a (patch)
tree8e45c2e340a63ca05aa73f8a44bf3c9d59494c0b /doc
parent3a36a2486e12be9150e28fa81ac707d65c425d45 (diff)
Replace ModeChange hooks by ModePush and ModePop
Remove deprecated InsertBegin, InsertEnd, NormalBegin, NormalEnd hooks. Closes #2545
Diffstat (limited to 'doc')
-rw-r--r--doc/pages/changelog.asciidoc4
-rw-r--r--doc/pages/hooks.asciidoc16
2 files changed, 6 insertions, 14 deletions
diff --git a/doc/pages/changelog.asciidoc b/doc/pages/changelog.asciidoc
index 0c8fd7d4..d30d3016 100644
--- a/doc/pages/changelog.asciidoc
+++ b/doc/pages/changelog.asciidoc
@@ -7,6 +7,10 @@ released versions.
* Arrow keys and `<home>`, `<end>` are not normal mode commands
anymore but default key mappings.
+
+* `ModeChange` hook parameter now takes `push:` or `pop:` prefix,
+ `InsertBegin`, `InsertEnd`, `NormalBegin` and `NormalEnd`
+ were removed.
== Kakoune 2019.07.01
diff --git a/doc/pages/hooks.asciidoc b/doc/pages/hooks.asciidoc
index 67058ecd..361d94d4 100644
--- a/doc/pages/hooks.asciidoc
+++ b/doc/pages/hooks.asciidoc
@@ -48,24 +48,12 @@ name. Hooks with no description will always use an empty string.
*NormalIdle*::
a certain duration has passed since the last keypress in normal mode
-*NormalBegin*::
- entering normal mode
-
-*NormalEnd*::
- leaving normal mode
-
*NormalKey* `key`::
a key is received in normal mode
*InsertIdle*::
a certain duration has passed since the last keypress in insert mode
-*InsertBegin*::
- entering insert mode
-
-*InsertEnd*::
- leaving insert mode
-
*InsertKey* `key`::
a key is received in insert mode
@@ -150,8 +138,8 @@ name. Hooks with no description will always use an empty string.
*RuntimeError* `error message`::
an error was encountered while executing a user command
-*ModeChange* `<old mode>:<new mode>`::
- Triggered whenever the current input mode changes
+*ModeChange* `[push|pop]:<old mode>:<new mode>`::
+ Triggered whenever a mode is pushed or removed from the mode stack.
*KakBegin* `session name`::
kakoune has started, this hook is called just after reading the user