aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJonas Bernoulli <jonas@bernoul.li>2025-06-10 17:22:45 +0200
committerJonas Bernoulli <jonas@bernoul.li>2025-06-10 17:22:45 +0200
commit0daafe08149b406ca0bf200a1ed0a8e4b1c1054a (patch)
tree8c9897ae5e3a338751881ad7e865852e84f3ffe3 /docs
parent925762e957c31e8bdf9e5630d2d99e98e4dc3abe (diff)
Clarify that commands run magit-section-movement-hook explicitly
Closes #5394.
Diffstat (limited to 'docs')
-rw-r--r--docs/magit.org20
-rw-r--r--docs/magit.texi20
2 files changed, 30 insertions, 10 deletions
diff --git a/docs/magit.org b/docs/magit.org
index bcf8177..f5fe175 100644
--- a/docs/magit.org
+++ b/docs/magit.org
@@ -891,6 +891,12 @@ To move within a section use the usual keys (~C-p~, ~C-n~, ~C-b~, ~C-f~ etc),
whose global bindings are not shadowed. To move to another section use
the following commands.
+The section movement commands described here run the hook
+~magit-section-movement-hook~. Note that they explicitly run that hook
+and that aribrary other movement, defined in Emacs and other packages,
+do not run that hook. That hook, and hook functions that can be added
+to it, or are part of its default value, are described below.
+
- Key: p (magit-section-backward) ::
When not at the beginning of a section, then move to the beginning
@@ -931,8 +937,10 @@ remove function that haven't even been added yet, for example:
- Variable: magit-section-movement-hook ::
- This hook is run by all of the above movement commands, after
- arriving at the destination.
+ This hook is run by all of the above section movement commands,
+ after arriving at the destination. It is *not* run by arbitrary other
+ movement commands (such as ~next-line~), which are provided by Emacs
+ or third-party packages.
- Function: magit-hunk-set-window-start ::
@@ -999,9 +1007,11 @@ remove function that haven't even been added yet, for example:
Delay before automatically updating the other window.
- When moving around in certain buffers, then certain other buffers,
- which are being displayed in another window, may optionally be
- updated to display information about the section at point.
+ When moving around in certain buffers using Magit's own section
+ movement commands (but not other movement commands), then certain
+ other buffers, which are being displayed in another window, may
+ optionally be updated to display information about the section at
+ point.
When holding down a key to move by more than just one section, then
that would update that buffer for each section on the way. To
diff --git a/docs/magit.texi b/docs/magit.texi
index 112bb13..22ee57f 100644
--- a/docs/magit.texi
+++ b/docs/magit.texi
@@ -1080,6 +1080,12 @@ To move within a section use the usual keys (@code{C-p}, @code{C-n}, @code{C-b},
whose global bindings are not shadowed. To move to another section use
the following commands.
+The section movement commands described here run the hook
+@code{magit-section-movement-hook}. Note that they explicitly run that hook
+and that aribrary other movement, defined in Emacs and other packages,
+do not run that hook. That hook, and hook functions that can be added
+to it, or are part of its default value, are described below.
+
@table @asis
@item @kbd{p} (@code{magit-section-backward})
@kindex p
@@ -1126,8 +1132,10 @@ remove function that haven't even been added yet, for example:
@end lisp
@defvar magit-section-movement-hook
-This hook is run by all of the above movement commands, after
-arriving at the destination.
+This hook is run by all of the above section movement commands,
+after arriving at the destination. It is @strong{not} run by arbitrary other
+movement commands (such as @code{next-line}), which are provided by Emacs
+or third-party packages.
@end defvar
@defun magit-hunk-set-window-start
@@ -1194,9 +1202,11 @@ in another window of the same frame.
@defopt magit-update-other-window-delay
Delay before automatically updating the other window.
-When moving around in certain buffers, then certain other buffers,
-which are being displayed in another window, may optionally be
-updated to display information about the section at point.
+When moving around in certain buffers using Magit's own section
+movement commands (but not other movement commands), then certain
+other buffers, which are being displayed in another window, may
+optionally be updated to display information about the section at
+point.
When holding down a key to move by more than just one section, then
that would update that buffer for each section on the way. To