[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/git-commit 03f495f351 3/3: manual: Use updated support for
|
From: |
ELPA Syncer |
|
Subject: |
[nongnu] elpa/git-commit 03f495f351 3/3: manual: Use updated support for definition commands |
|
Date: |
Sun, 26 Dec 2021 02:57:45 -0500 (EST) |
branch: elpa/git-commit
commit 03f495f351d6e622143e4628681019df1313a5f2
Author: Jonas Bernoulli <jonas@bernoul.li>
Commit: Jonas Bernoulli <jonas@bernoul.li>
manual: Use updated support for definition commands
Instead of ox-texinfo+.el use the new implementation
that I expect to be merged into Org itself.
---
default.mk | 1 -
docs/.orgconfig | 4 +-
docs/Makefile | 3 +-
docs/magit-section.org | 28 +-
docs/magit-section.texi | 20 +-
docs/magit.org | 1450 ++++++++++++++-------------
docs/magit.texi | 2516 +++++++++++++++--------------------------------
7 files changed, 1531 insertions(+), 2491 deletions(-)
diff --git a/default.mk b/default.mk
index bdef87ac2c..db97261cd0 100644
--- a/default.mk
+++ b/default.mk
@@ -218,7 +218,6 @@ endif # ifndef LOAD_PATH
ifndef ORG_LOAD_PATH
ORG_LOAD_PATH = $(LOAD_PATH)
ORG_LOAD_PATH += -L ../../org/lisp
-ORG_LOAD_PATH += -L ../../ox-texinfo+
endif
## Publish ###########################################################
diff --git a/docs/.orgconfig b/docs/.orgconfig
index 7e3fc15660..6b4a0c9083 100644
--- a/docs/.orgconfig
+++ b/docs/.orgconfig
@@ -3,8 +3,8 @@
#+options: H:4 num:3 toc:2
#+property: header-args :eval never
-#+texinfo_deffn: t
+#+macro: kbd (eval (let ((case-fold-search nil) (regexp (regexp-opt '("SPC"
"RET" "LFD" "TAB" "BS" "ESC" "DELETE" "SHIFT" "Ctrl" "Meta" "Alt" "Cmd" "Super"
"UP" "LEFT" "RIGHT" "DOWN") 'words))) (format
"@@texinfo:@kbd{@@%s@@texinfo:}@@" (replace-regexp-in-string regexp
"@@texinfo:@key{@@\\&@@texinfo:}@@" $1 t))))
#+macro: year (eval (format-time-string "%Y"))
-#+macro: version (eval (ox-texinfo+-get-version 'mixed))
+#+macro: version (eval (or (getenv "PACKAGE-VERSION") (ignore-errors (car
(process-lines "git" "describe" "--exact"))) (ignore-errors (concat (car
(process-lines "git" "describe" (if (getenv "AMEND") "HEAD~" "HEAD"))) "+1"))))
#+language: en
diff --git a/docs/Makefile b/docs/Makefile
index 5a348621b9..cad67df7f8 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -86,9 +86,8 @@ clean-stats:
## Release management ################################################
-ORG_ARGS = --batch -Q $(ORG_LOAD_PATH) -l ox-texinfo+
+ORG_ARGS = --batch -Q $(ORG_LOAD_PATH)
ORG_ARGS += -l magit-utils -l ol-man
-ORG_EVAL = --eval "(setq org-texinfo+-dissolve-noexport-headlines t)"
ORG_EVAL += --eval "(setq indent-tabs-mode nil)"
ORG_EVAL += --eval "(setq org-src-preserve-indentation nil)"
ORG_EVAL += --funcall org-texinfo-export-to-texinfo
diff --git a/docs/magit-section.org b/docs/magit-section.org
index 096c4d14c5..9a04fffa9f 100644
--- a/docs/magit-section.org
+++ b/docs/magit-section.org
@@ -52,10 +52,9 @@ When the documentation leaves something unaddressed, then
please
consider that Magit uses this library extensively and search its
source for suitable examples before asking me for help. Thanks!
-
* Creating Sections
-- Macro: magit-insert-section [name] (type &optional value hide) &rest body
+- Macro: magit-insert-section [name] (type &optional value hide) &rest body ::
Create a section object of type CLASS, storing VALUE in its
~value~ slot, and insert the section at point. CLASS is a
@@ -99,7 +98,7 @@ source for suitable examples before asking me for help.
Thanks!
a section by washing Git's output and Git didn't actually output
anything this time around.
-- Function: magit-insert-heading &rest args
+- Function: magit-insert-heading &rest args ::
Insert the heading for the section currently being inserted.
@@ -128,19 +127,19 @@ source for suitable examples before asking me for help.
Thanks!
getting it right. The only exception is that this function does
insert a newline character if necessary.
-- Macro: magit-insert-section-body &rest body
+- Macro: magit-insert-section-body &rest body ::
Use BODY to insert the section body, once the section is expanded.
If the section is expanded when it is created, then this is
like ~progn~. Otherwise BODY isn't evaluated until the section
is explicitly expanded.
-- Function: magit-cancel-section
+- Function: magit-cancel-section ::
Cancel inserting the section that is currently being inserted.
Remove all traces of that section.
-- Function: magit-wash-sequence function
+- Function: magit-wash-sequence function ::
Repeatedly call FUNCTION until it returns ~nil~ or the end of the
buffer is reached. FUNCTION has to move point forward or return
@@ -148,16 +147,16 @@ source for suitable examples before asking me for help.
Thanks!
* Core Functions
-- Function: magit-current-section
+- Function: magit-current-section ::
Return the section at point.
-- Function: magit-section-ident section
+- Function: magit-section-ident section ::
Return an unique identifier for SECTION. The return value has the
form ~((TYPE . VALUE)...)~.
-- Function: magit-section-ident-value value
+- Function: magit-section-ident-value value ::
Return a constant representation of VALUE.
@@ -169,21 +168,21 @@ source for suitable examples before asking me for help.
Thanks!
catch-all method is used, which just returns the argument
itself.
-- Function: magit-get-section ident &optional root
+- Function: magit-get-section ident &optional root ::
Return the section identified by IDENT.
IDENT has to be a list as returned by ~magit-section-ident~.
If optional ROOT is non-nil, then search in that section tree
instead of in the one whose root ~magit-root-section~ is.
-- Function: magit-section-lineage section
+- Function: magit-section-lineage section ::
Return the lineage of SECTION.
The return value has the form ~(TYPE...)~.
* Matching Functions
-- Function: magit-section-match condition &optional (section
(magit-current-section))
+- Function: magit-section-match condition &optional (section
(magit-current-section)) ::
Return t if SECTION matches CONDITION.
@@ -217,7 +216,7 @@ source for suitable examples before asking me for help.
Thanks!
lineage as printed by ~magit-describe-section-briefly~, unless
of course you want to be that precise.
-- Function: magit-section-value-if condition &optional section
+- Function: magit-section-value-if condition &optional section ::
If the section at point matches CONDITION, then return its value.
@@ -228,7 +227,7 @@ source for suitable examples before asking me for help.
Thanks!
See ~magit-section-match~ for the forms CONDITION can take.
-- Macro: magit-section-case &rest clauses
+- Macro: magit-section-case &rest clauses ::
Choose among clauses on the type of the section at point.
@@ -272,7 +271,6 @@ General Public License for more details.
# Local Variables:
# eval: (require 'magit-utils nil t)
# eval: (require 'ol-man nil t)
-# eval: (require 'ox-texinfo+ nil t)
# indent-tabs-mode: nil
# org-src-preserve-indentation: nil
# End:
diff --git a/docs/magit-section.texi b/docs/magit-section.texi
index 3d357c6dd5..86b0b2515e 100644
--- a/docs/magit-section.texi
+++ b/docs/magit-section.texi
@@ -31,7 +31,7 @@ General Public License for more details.
@finalout
@titlepage
@title Magit-Section Developer Manual
-@subtitle for version 3.3.0
+@subtitle for version v3.3.0-72-geb0d359dc+1
@author Jonas Bernoulli
@page
@vskip 0pt plus 1filll
@@ -54,7 +54,7 @@ user options see @ref{Sections,,,magit,}. This manual
documents how you
can use sections in your own packages.
@noindent
-This manual is for Magit-Section version 3.3.0.
+This manual is for Magit-Section version v3.3.0-72-geb0d359dc+1.
@quotation
Copyright (C) 2015-2021 Jonas Bernoulli <jonas@@bernoul.li>
@@ -99,7 +99,6 @@ source for suitable examples before asking me for help.
Thanks!
@chapter Creating Sections
@defmac magit-insert-section [name] (type &optional value hide) &rest body
-
Create a section object of type CLASS, storing VALUE in its
@code{value} slot, and insert the section at point. CLASS is a
subclass of `magit-section' or has the form @code{(eval FORM)}, in
@@ -144,7 +143,6 @@ anything this time around.
@end defmac
@defun magit-insert-heading &rest args
-
Insert the heading for the section currently being inserted.
This function should only be used inside @code{magit-insert-section}.
@@ -174,7 +172,6 @@ insert a newline character if necessary.
@end defun
@defmac magit-insert-section-body &rest body
-
Use BODY to insert the section body, once the section is expanded.
If the section is expanded when it is created, then this is
like @code{progn}. Otherwise BODY isn't evaluated until the section
@@ -182,13 +179,11 @@ is explicitly expanded.
@end defmac
@defun magit-cancel-section
-
Cancel inserting the section that is currently being inserted.
Remove all traces of that section.
@end defun
@defun magit-wash-sequence function
-
Repeatedly call FUNCTION until it returns @code{nil} or the end of the
buffer is reached. FUNCTION has to move point forward or return
@code{nil}.
@@ -198,18 +193,15 @@ buffer is reached. FUNCTION has to move point forward or
return
@chapter Core Functions
@defun magit-current-section
-
Return the section at point.
@end defun
@defun magit-section-ident section
-
Return an unique identifier for SECTION@. The return value has the
form @code{((TYPE . VALUE)...)}.
@end defun
@defun magit-section-ident-value value
-
Return a constant representation of VALUE@.
VALUE is the value of a @code{magit-section} object. If that is an
@@ -222,7 +214,6 @@ itself.
@end defun
@defun magit-get-section ident &optional root
-
Return the section identified by IDENT@.
IDENT has to be a list as returned by @code{magit-section-ident}.
If optional ROOT is non-nil, then search in that section tree
@@ -230,7 +221,6 @@ instead of in the one whose root @code{magit-root-section}
is.
@end defun
@defun magit-section-lineage section
-
Return the lineage of SECTION@.
The return value has the form @code{(TYPE...)}.
@end defun
@@ -239,7 +229,6 @@ The return value has the form @code{(TYPE...)}.
@chapter Matching Functions
@defun magit-section-match condition &optional (section
(magit-current-section))
-
Return t if SECTION matches CONDITION@.
SECTION defaults to the section at point. If SECTION is not
@@ -251,18 +240,15 @@ CONDITION can take the following forms:
@itemize
@item
@code{(CONDITION...)} matches if any of the CONDITIONs matches.
-
@item
@code{[CLASS...]} matches if the section's class is the same
as the first CLASS or a subclass of that;
the section's parent class matches the
second CLASS; and so on.
-
@item
@code{[* CLASS...]} matches sections that match [CLASS@dots{}] and
also recursively all their child sections.
-
@item
@code{CLASS} matches if the section's class is the same
as CLASS or a subclass of that; regardless
@@ -283,7 +269,6 @@ of course you want to be that precise.
@end defun
@defun magit-section-value-if condition &optional section
-
If the section at point matches CONDITION, then return its value.
If optional SECTION is non-nil then test whether that matches
@@ -295,7 +280,6 @@ See @code{magit-section-match} for the forms CONDITION can
take.
@end defun
@defmac magit-section-case &rest clauses
-
Choose among clauses on the type of the section at point.
Each clause looks like @code{(CONDITION BODY...)}. The type of the
diff --git a/docs/magit.org b/docs/magit.org
index e14d0a58a8..eb16fd6e9f 100644
--- a/docs/magit.org
+++ b/docs/magit.org
@@ -385,7 +385,7 @@ the user invokes Git commands, or creates or visits other
buffers.
In this manual we often speak about "Magit buffers". By that we mean
buffers whose major-modes derive from ~magit-mode~.
-- Key: M-x magit-toggle-buffer-lock, magit-toggle-buffer-lock
+- Key: M-x magit-toggle-buffer-lock ::
This command locks the current buffer to its value or if the buffer
is already locked, then it unlocks it.
@@ -406,7 +406,7 @@ buffers whose major-modes derive from ~magit-mode~.
*** Switching Buffers
-- Function: magit-display-buffer buffer &optional display-function
+- Function: magit-display-buffer buffer &optional display-function ::
This function is a wrapper around ~display-buffer~ and is used to
display any Magit buffer. It displays BUFFER in some window and,
@@ -418,7 +418,7 @@ buffers whose major-modes derive from ~magit-mode~.
display the buffer. Usually that is ~nil~ and the function specified
by ~magit-display-buffer-function~ is used.
-- Variable: magit-display-buffer-noselect
+- Variable: magit-display-buffer-noselect ::
When this is non-nil, then ~magit-display-buffer~ only displays the
buffer but forgoes also selecting the window. This variable should
@@ -427,7 +427,7 @@ buffers whose major-modes derive from ~magit-mode~.
example when the revision buffer is updated when you move inside the
log buffer.
-- User Option: magit-display-buffer-function
+- User Option: magit-display-buffer-function ::
The function specified here is called by ~magit-display-buffer~ with
one argument, a buffer, to actually display that buffer. This
@@ -445,7 +445,7 @@ buffers whose major-modes derive from ~magit-mode~.
To learn about display actions, see [[info:elisp#Choosing Window]].
-- Function: magit-display-buffer-traditional buffer
+- Function: magit-display-buffer-traditional buffer ::
This function is the current default value of the option
~magit-display-buffer-function~. Before that option and this function
@@ -453,19 +453,19 @@ buffers whose major-modes derive from ~magit-mode~.
code base but now all the rules are contained in this one function
(except for the "noselect" special case mentioned above).
-- Function: magit-display-buffer-same-window-except-diff-v1
+- Function: magit-display-buffer-same-window-except-diff-v1 ::
This function displays most buffers in the currently selected
window. If a buffer's mode derives from ~magit-diff-mode~ or
~magit-process-mode~, it is displayed in another window.
-- Function: magit-display-buffer-fullframe-status-v1
+- Function: magit-display-buffer-fullframe-status-v1 ::
This function fills the entire frame when displaying a status
buffer. Otherwise, it behaves like
~magit-display-buffer-traditional~.
-- Function: magit-display-buffer-fullframe-status-topleft-v1
+- Function: magit-display-buffer-fullframe-status-topleft-v1 ::
This function fills the entire frame when displaying a status
buffer. It behaves like ~magit-display-buffer-fullframe-status-v1~
@@ -475,7 +475,7 @@ buffers whose major-modes derive from ~magit-mode~.
to pop up on the same side as they would if
~magit-display-buffer-traditional~ were in use.
-- Function: magit-display-buffer-fullcolumn-most-v1
+- Function: magit-display-buffer-fullcolumn-most-v1 ::
This function displays most buffers so that they fill the entire
height of the frame. However, the buffer is displayed in another
@@ -484,23 +484,23 @@ buffers whose major-modes derive from ~magit-mode~.
that the mode of the current buffer derives from ~magit-log-mode~ or
~magit-cherry-mode~.
-- User Option: magit-pre-display-buffer-hook
+- User Option: magit-pre-display-buffer-hook ::
This hook is run by ~magit-display-buffer~ before displaying the
buffer.
-- Function: magit-save-window-configuration
+- Function: magit-save-window-configuration ::
This function saves the current window configuration. Later when
the buffer is buried, it may be restored by
~magit-restore-window-configuration~.
-- User Option: magit-post-display-buffer-hook
+- User Option: magit-post-display-buffer-hook ::
This hook is run by ~magit-display-buffer~ after displaying the
buffer.
-- Function: magit-maybe-set-dedicated
+- Function: magit-maybe-set-dedicated ::
This function remembers if a new window had to be created to display
the buffer, or whether an existing window was reused. This
@@ -510,7 +510,7 @@ buffers whose major-modes derive from ~magit-mode~.
*** Naming Buffers
-- User Option: magit-generate-buffer-name-function
+- User Option: magit-generate-buffer-name-function ::
The function used to generate the names of Magit buffers.
@@ -521,7 +521,7 @@ buffers whose major-modes derive from ~magit-mode~.
~magit-buffer-name-format~, then its own doc-string should describe
the additions.
-- Function: magit-generate-buffer-name-default-function mode
+- Function: magit-generate-buffer-name-default-function mode ::
This function returns a buffer name suitable for a buffer whose
major-mode is MODE and which shows information about the repository
@@ -531,7 +531,7 @@ buffers whose major-modes derive from ~magit-mode~.
the %-sequences mentioned the documentation of that option. It also
respects the option ~magit-uniquify-buffer-names~.
-- User Option: magit-buffer-name-format
+- User Option: magit-buffer-name-format ::
The format string used to name Magit buffers.
@@ -576,7 +576,7 @@ buffers whose major-modes derive from ~magit-mode~.
value must end with ~%t~ or ~%t%x~ (or the obsolete ~%T~). See issue
#2841.
-- User Option: magit-uniquify-buffer-names
+- User Option: magit-uniquify-buffer-names ::
This option controls whether the names of Magit buffers are
uniquified. If the names are not being uniquified, then they
@@ -591,7 +591,7 @@ buffers whose major-modes derive from ~magit-mode~.
*** Quitting Windows
-- Key: q, magit-mode-bury-buffer
+- Key: q (magit-mode-bury-buffer) ::
This command buries the current Magit buffer.
@@ -599,7 +599,7 @@ buffers whose major-modes derive from ~magit-mode~.
prefix argument, also kills all other Magit buffers associated with
the current project.
-- User Option: magit-bury-buffer-function
+- User Option: magit-bury-buffer-function ::
The function used to actually bury or kill the current buffer.
@@ -608,7 +608,7 @@ buffers whose major-modes derive from ~magit-mode~.
buffer. Otherwise it has to bury it alive. The default value
currently is ~magit-restore-window-configuration~.
-- Function: magit-restore-window-configuration kill-buffer
+- Function: magit-restore-window-configuration kill-buffer ::
Bury or kill the current buffer using ~quit-window~, which is called
with KILL-BUFFER as first and the selected window as second
@@ -619,7 +619,7 @@ buffers whose major-modes derive from ~magit-mode~.
that also means that point gets adjusted in all the buffers, which
are being displayed in the selected frame.
-- Function: magit-mode-quit-window kill-buffer
+- Function: magit-mode-quit-window kill-buffer ::
Bury or kill the current buffer using ~quit-window~, which is called
with KILL-BUFFER as first and the selected window as second
@@ -652,7 +652,7 @@ Buffers can also be refreshed explicitly, which is useful
in buffers
that weren't current during the last refresh and after changes were
made to the repository outside of Magit.
-- Key: g, magit-refresh
+- Key: g (magit-refresh) ::
This command refreshes the current buffer if its major mode derives
from ~magit-mode~ as well as the corresponding status buffer.
@@ -661,7 +661,7 @@ made to the repository outside of Magit.
reverts all unmodified buffers that visit files being tracked in the
current repository.
-- Key: G, magit-refresh-all
+- Key: G (magit-refresh-all) ::
This command refreshes all Magit buffers belonging to the current
repository and also reverts all unmodified buffers that visit files
@@ -670,12 +670,12 @@ made to the repository outside of Magit.
The file-visiting buffers are always reverted, even if
~magit-revert-buffers~ is nil.
-- User Option: magit-refresh-buffer-hook
+- User Option: magit-refresh-buffer-hook ::
This hook is run in each Magit buffer that was refreshed during the
current refresh - normally the current buffer and the status buffer.
-- User Option: magit-refresh-status-buffer
+- User Option: magit-refresh-status-buffer ::
When this option is non-nil, then the status buffer is automatically
refreshed after running git for side-effects, in addition to the
@@ -684,7 +684,7 @@ made to the repository outside of Magit.
Only set this to nil after exhausting all other options to improve
performance.
-- Function: magit-after-save-refresh-status
+- Function: magit-after-save-refresh-status ::
This function is intended to be added to ~after-save-hook~. After
doing that the corresponding status buffer is refreshed whenever a
@@ -704,7 +704,7 @@ Magit to interact with Git, one can be fairly confident.
When in
doubt or after outside changes, type ~g~ (~magit-refresh~) to save and
refresh explicitly.
-- User Option: magit-save-repository-buffers
+- User Option: magit-save-repository-buffers ::
This option controls whether file-visiting buffers are saved before
certain events.
@@ -728,12 +728,12 @@ file to have "changed on disk". If Magit did not
automatically revert
the buffer, then you would have to type ~M-x revert-buffer RET RET~ in
the visiting buffer before you could continue making changes.
-- User Option: magit-auto-revert-mode
+- User Option: magit-auto-revert-mode ::
When this mode is enabled, then buffers that visit tracked files
are automatically reverted after the visited files change on disk.
-- User Option: global-auto-revert-mode
+- User Option: global-auto-revert-mode ::
When this mode is enabled, then any file-visiting buffer is
automatically reverted after the visited file changes on disk.
@@ -743,7 +743,7 @@ the visiting buffer before you could continue making
changes.
just those visiting tracked files. If that is the case, then enable
this mode /instead of/ ~magit-auto-revert-mode~.
-- User Option: magit-auto-revert-immediately
+- User Option: magit-auto-revert-immediately ::
This option controls whether Magit reverts buffers immediately.
@@ -760,20 +760,20 @@ the visiting buffer before you could continue making
changes.
~nil~, then reverts happen after ~auto-revert-interval~ seconds of user
inactivity. That is not desirable.
-- User Option: auto-revert-use-notify
+- User Option: auto-revert-use-notify ::
This option controls whether file notification functions should be
used. Note that this variable unfortunately defaults to ~t~ even on
systems on which file notifications cannot be used.
-- User Option: magit-auto-revert-tracked-only
+- User Option: magit-auto-revert-tracked-only ::
This option controls whether ~magit-auto-revert-mode~ only reverts
tracked files or all files that are located inside Git repositories,
including untracked files and files located inside Git's control
directory.
-- User Option: auto-revert-mode
+- User Option: auto-revert-mode ::
The global mode ~magit-auto-revert-mode~ works by turning on this
local mode in the appropriate buffers (but ~global-auto-revert-mode~
@@ -781,17 +781,17 @@ the visiting buffer before you could continue making
changes.
manually, which might be necessary if Magit does not notice that a
previously untracked file now is being tracked or vice-versa.
-- User Option: auto-revert-stop-on-user-input
+- User Option: auto-revert-stop-on-user-input ::
This option controls whether the arrival of user input suspends the
automatic reverts for ~auto-revert-interval~ seconds.
-- User Option: auto-revert-interval
+- User Option: auto-revert-interval ::
This option controls how many seconds Emacs waits for before
resuming suspended reverts.
-- User Option: auto-revert-buffer-list-filter
+- User Option: auto-revert-buffer-list-filter ::
This option specifies an additional filter used by
~auto-revert-buffers~ to determine whether a buffer should be reverted
@@ -812,7 +812,7 @@ the visiting buffer before you could continue making
changes.
who turn on ~global-auto-revert-mode~, do not have to worry about this
option, because it is disregarded if the global mode is enabled.
-- User Option: auto-revert-verbose
+- User Option: auto-revert-verbose ::
This option controls whether Emacs reports when a buffer has been
reverted.
@@ -886,28 +886,28 @@ 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.
-- Key: p, magit-section-backward
+- Key: p (magit-section-backward) ::
When not at the beginning of a section, then move to the beginning
of the current section. At the beginning of a section, instead move
to the beginning of the previous visible section.
-- Key: n, magit-section-forward
+- Key: n (magit-section-forward) ::
Move to the beginning of the next visible section.
-- Key: M-p, magit-section-backward-siblings
+- Key: M-p (magit-section-backward-siblings) ::
Move to the beginning of the previous sibling section. If there is
no previous sibling section, then move to the parent section
instead.
-- Key: M-n, magit-section-forward-siblings
+- Key: M-n (magit-section-forward-siblings) ::
Move to the beginning of the next sibling section. If there is no
next sibling section, then move to the parent section instead.
-- Key: ^, magit-section-up
+- Key: ^ (magit-section-up) ::
Move to the beginning of the parent of the current section.
@@ -924,12 +924,12 @@ remove function that haven't even been added yet, for
example:
'magit-hunk-set-window-start))
#+end_src
-- Variable: magit-section-movement-hook
+- Variable: magit-section-movement-hook ::
This hook is run by all of the above movement commands, after
arriving at the destination.
-- Function: magit-hunk-set-window-start
+- Function: magit-hunk-set-window-start ::
This hook function ensures that the beginning of the current section
is visible, provided it is a ~hunk~ section. Otherwise, it does
@@ -937,14 +937,14 @@ remove function that haven't even been added yet, for
example:
Loading ~magit-diff~ adds this function to the hook.
-- Function: magit-section-set-window-start
+- Function: magit-section-set-window-start ::
This hook function ensures that the beginning of the current section
is visible, regardless of the section's type. If you add this to
~magit-section-movement-hook~, then you must remove the hunk-only
variant in turn.
-- Function: magit-log-maybe-show-more-commits
+- Function: magit-log-maybe-show-more-commits ::
This hook function only has an effect in log buffers, and ~point~ is
on the "show more" section. If that is the case, then it doubles
@@ -952,7 +952,7 @@ remove function that haven't even been added yet, for
example:
Loading ~magit-log~ adds this function to the hook.
-- Function: magit-log-maybe-update-revision-buffer
+- Function: magit-log-maybe-update-revision-buffer ::
When moving inside a log buffer, then this function updates the
revision buffer, provided it is already being displayed in another
@@ -960,37 +960,37 @@ remove function that haven't even been added yet, for
example:
Loading ~magit-log~ adds this function to the hook.
-- Function: magit-log-maybe-update-blob-buffer
+- Function: magit-log-maybe-update-blob-buffer ::
When moving inside a log buffer and another window of the same frame
displays a blob buffer, then this function instead displays the blob
buffer for the commit at point in that window.
-- Function: magit-status-maybe-update-revision-buffer
+- Function: magit-status-maybe-update-revision-buffer ::
When moving inside a status buffer, then this function updates the
revision buffer, provided it is already being displayed in another
window of the same frame.
-- Function: magit-status-maybe-update-stash-buffer
+- Function: magit-status-maybe-update-stash-buffer ::
When moving inside a status buffer, then this function updates the
stash buffer, provided it is already being displayed in another
window of the same frame.
-- Function: magit-status-maybe-update-blob-buffer
+- Function: magit-status-maybe-update-blob-buffer ::
When moving inside a status buffer and another window of the same
frame displays a blob buffer, then this function instead displays
the blob buffer for the commit at point in that window.
-- Function: magit-stashes-maybe-update-stash-buffer
+- Function: magit-stashes-maybe-update-stash-buffer ::
When moving inside a buffer listing stashes, then this function
updates the stash buffer, provided it is already being displayed
in another window of the same frame.
-- User Option: magit-update-other-window-delay
+- User Option: magit-update-other-window-delay ::
Delay before automatically updating the other window.
@@ -1010,33 +1010,33 @@ remove function that haven't even been added yet, for
example:
Magit provides many commands for changing the visibility of sections,
but all you need to get started are the next two.
-- Key: TAB, magit-section-toggle
+- Key: TAB (magit-section-toggle) ::
Toggle the visibility of the body of the current section.
-- Key: C-<tab>, magit-section-cycle
+- Key: C-<tab> (magit-section-cycle) ::
Cycle the visibility of current section and its children.
-- Key: M-<tab>, magit-section-cycle-diffs
+- Key: M-<tab> (magit-section-cycle-diffs) ::
Cycle the visibility of diff-related sections in the current buffer.
-- Key: S-<tab>, magit-section-cycle-global
+- Key: S-<tab> (magit-section-cycle-global) ::
Cycle the visibility of all sections in the current buffer.
-- Key: 1, magit-section-show-level-1
-- Key: 2, magit-section-show-level-2
-- Key: 3, magit-section-show-level-3
-- Key: 4, magit-section-show-level-4
+- Key: 1 (magit-section-show-level-1) ::
++ Key: 2 (magit-section-show-level-2) ::
++ Key: 3 (magit-section-show-level-3) ::
++ Key: 4 (magit-section-show-level-4) ::
Show sections surrounding the current section up to level N.
-- Key: M-1, magit-section-show-level-1-all
-- Key: M-2, magit-section-show-level-2-all
-- Key: M-3, magit-section-show-level-3-all
-- Key: M-4, magit-section-show-level-4-all
+- Key: M-1 (magit-section-show-level-1-all) ::
++ Key: M-2 (magit-section-show-level-2-all) ::
++ Key: M-3 (magit-section-show-level-3-all) ::
++ Key: M-4 (magit-section-show-level-4-all) ::
Show all sections up to level N.
@@ -1045,30 +1045,30 @@ also exposed as commands themselves. By default no
keys are bound to
these commands, as they are generally perceived to be much less
useful. But your mileage may vary.
-- Command: magit-section-show
+- Command: magit-section-show ::
Show the body of the current section.
-- Command: magit-section-hide
+- Command: magit-section-hide ::
Hide the body of the current section.
-- Command: magit-section-show-headings
+- Command: magit-section-show-headings ::
Recursively show headings of children of the current section. Only
show the headings. Previously shown text-only bodies are hidden.
-- Command: magit-section-show-children
+- Command: magit-section-show-children ::
Recursively show the bodies of children of the current section.
With a prefix argument show children down to the level of the
current section, and hide deeper children.
-- Command: magit-section-hide-children
+- Command: magit-section-hide-children ::
Recursively hide the bodies of children of the current section.
-- Command: magit-section-toggle-children
+- Command: magit-section-toggle-children ::
Toggle visibility of bodies of children of the current section.
@@ -1078,7 +1078,7 @@ then the previous visibility is preserved. The initial
visibility of
certain sections can also be overwritten using the hook
~magit-section-set-visibility-hook~.
-- User Option: magit-section-initial-visibility-alist
+- User Option: magit-section-initial-visibility-alist ::
This options can be used to override the initial visibility of
sections. In the future it will also be used to define the
@@ -1094,7 +1094,7 @@ certain sections can also be overwritten using the hook
lineage and the type is the first element of that vector. Wildcards
can be used, see ~magit-section-match~.
-- User Option: magit-section-cache-visibility
+- User Option: magit-section-cache-visibility ::
This option controls for which sections the previous visibility
state should be restored if a section disappears and later appears
@@ -1105,7 +1105,7 @@ certain sections can also be overwritten using the hook
This requires that the function ~magit-section-cached-visibility~ is
a member of ~magit-section-set-visibility-hook~.
-- Variable: magit-section-set-visibility-hook
+- Variable: magit-section-set-visibility-hook ::
This hook is run when first creating a buffer and also when
refreshing an existing buffer, and is used to determine the
@@ -1122,7 +1122,7 @@ certain sections can also be overwritten using the hook
then the buffer is being refreshed and these functions should
immediately return ~nil~.
-- User Option: magit-section-visibility-indicator
+- User Option: magit-section-visibility-indicator ::
This option controls whether and how to indicate that a section can
be expanded/collapsed.
@@ -1169,7 +1169,7 @@ Custom interface.
The various available section hook variables are described later in
this manual along with the appropriate "section inserter functions".
-- Function: magit-add-section-hook hook function &optional at append local
+- Function: magit-add-section-hook hook function &optional at append local ::
Add the function FUNCTION to the value of section hook HOOK.
@@ -1207,12 +1207,12 @@ section of type ~file~, for example, is a file name.
Users usually do not have to worry about a section's type and value,
but knowing them can be handy at times.
-- Key: H, magit-describe-section
+- Key: H (magit-describe-section) ::
This command shows information about the section at point in a
separate buffer.
-- Command: magit-describe-section-briefly
+- Command: magit-describe-section-briefly ::
This command shows information about the section at point in the
echo area, as ~#<magit-section VALUE [TYPE PARENT-TYPE...]
@@ -1234,7 +1234,7 @@ yourself, and it will automatically be used.
This section describes options that have an effect on more than just a
certain type of sections. As you can see there are not many of those.
-- User Option: magit-section-show-child-count
+- User Option: magit-section-show-child-count ::
Whether to append the number of children to section headings. This
only affects sections that could benefit from this information.
@@ -1253,7 +1253,7 @@ used the package ~magit-popup~ and even earlier versions
library
Transient is documented in [[info:transient]].
-- Key: C-c C-c, magit-dispatch
+- Key: C-c C-c (magit-dispatch) ::
This transient prefix command binds most of Magit's other prefix
commands as suffix commands and displays them in a temporary buffer
@@ -1329,7 +1329,7 @@ press ~RET~ on another commit to show that instead and
the diff
arguments are reset to the default. Not cool; so Magit does not do
that by default.
-- User Option: magit-prefix-use-buffer-arguments
+- User Option: magit-prefix-use-buffer-arguments ::
This option controls whether the infix arguments initially shown in
certain transient prefix commands are based on the arguments that
@@ -1338,7 +1338,7 @@ that by default.
The ~magit-diff~ and ~magit-log~ transient prefix commands are affected
by this option.
-- User Option: magit-direct-use-buffer-arguments
+- User Option: magit-direct-use-buffer-arguments ::
This option controls whether certain commands, when invoked directly
(i.e. not as the suffix of a transient prefix command), use the
@@ -1411,7 +1411,7 @@ while this option can only be used to disable
confirmation for a
specific set of actions, the next section explains another way of
telling Magit to ask fewer questions.
-- User Option: magit-no-confirm
+- User Option: magit-no-confirm ::
The value of this option is a list of symbols, representing actions
that do not have to be confirmed by the user before being carried
@@ -1583,7 +1583,7 @@ Also note that Magit asks for confirmation of certain
actions that are
not coupled with completion (or the selection). Such dialogs are also
not affected by this option and are described in the previous section.
-- User Option: magit-dwim-selection
+- User Option: magit-dwim-selection ::
This option can be used to tell certain commands to use the thing
at point instead of asking the user to select a candidate to act
@@ -1655,7 +1655,7 @@ selected sections. The latter would be much more
surprising and if
the current section always is part of the selection, then that cannot
happen.
-- Variable: magit-keep-region-overlay
+- Variable: magit-keep-region-overlay ::
This variable controls whether the region is visualized as usual
even when a valid Magit selection or a hunk-internal region exists.
@@ -1704,7 +1704,7 @@ However if you want to use Ido, then ~ido-mode~ won't do
the trick. You
will also have to install the ~ido-completing-read+~ package and use
~magit-ido-completing-read~ as ~magit-completing-read-function~.
-- User Option: magit-completing-read-function
+- User Option: magit-completing-read-function ::
The value of this variable is the low-level function used to perform
completion by code that uses ~magit-completing-read~ (as opposed to
@@ -1718,12 +1718,12 @@ will also have to install the ~ido-completing-read+~
package and use
some additional work, and any function used in its place has to do
the same.
-- Function: magit-builtin-completing-read prompt choices &optional predicate
require-match initial-input hist def
+- Function: magit-builtin-completing-read prompt choices &optional predicate
require-match initial-input hist def ::
This function performs completion using the built-in ~completing-read~
and does some additional magit-specific work.
-- Function: magit-ido-completing-read prompt choices &optional predicate
require-match initial-input hist def
+- Function: magit-ido-completing-read prompt choices &optional predicate
require-match initial-input hist def ::
This function performs completion using ~ido-completing-read+~ from the
package by the same name (which you have to explicitly install) and
@@ -1734,7 +1734,7 @@ will also have to install the ~ido-completing-read+~
package and use
while intended as a drop-in replacement, cannot serve that purpose
because it violates too many of the implicit conventions.
-- Function: magit-completing-read prompt choices &optional predicate
require-match initial-input hist def fallback
+- Function: magit-completing-read prompt choices &optional predicate
require-match initial-input hist def fallback ::
This is the function that Magit commands use when they need the user
to select a single thing to act on. The arguments have the same
@@ -1775,7 +1775,7 @@ will also have to install the ~ido-completing-read+~
package and use
*** Additional Completion Options
-- User Option: magit-list-refs-sortby
+- User Option: magit-list-refs-sortby ::
For many commands that read a ref or refs from the user, the value
of this option can be used to control the order of the refs. Valid
@@ -1796,7 +1796,7 @@ per-repository log buffer, which can be consulted using
the
The output/errors for up to `magit-process-log-max' Git commands are
retained.
-- Key: $, magit-process
+- Key: $ (magit-process) ::
This commands displays the process buffer for the current
repository.
@@ -1804,11 +1804,11 @@ retained.
Inside that buffer, the usual key bindings for navigating and showing
sections are available. There is one additional command.
-- Key: k, magit-process-kill
+- Key: k (magit-process-kill) ::
This command kills the process represented by the section at point.
-- Variable: magit-git-debug
+- Variable: magit-git-debug ::
This option controls whether additional reporting of git errors is
enabled.
@@ -1827,7 +1827,7 @@ sections are available. There is one additional command.
This is only intended for debugging purposes. Do not enable this
permanently, that would negatively affect performance.
-- Variable: magit-process-extreme-logging
+- Variable: magit-process-extreme-logging ::
This option controls whether ~magit-process-file~ logs to the
~*Messages*~ buffer.
@@ -1865,12 +1865,12 @@ come in handy. Magit provides some commands for
running arbitrary Git
commands by typing them into the minibuffer, instead of having to
switch to a shell.
-- Key: !, magit-run
+- Key: ! (magit-run) ::
This transient prefix command binds the following suffix commands
and displays them in a temporary buffer until a suffix is invoked.
-- Key: ! !, magit-git-command-topdir
+- Key: ! ! (magit-git-command-topdir) ::
This command reads a command from the user and executes it in the
top-level directory of the current working tree.
@@ -1878,8 +1878,8 @@ switch to a shell.
The string "git " is used as initial input when prompting the user
for the command. It can be removed to run another command.
-- Key: :, magit-git-command
-- Key: ! p, magit-git-command
+- Key: : (magit-git-command) ::
+- Key: ! p ::
This command reads a command from the user and executes it in
~default-directory~. With a prefix argument the command is executed
@@ -1888,37 +1888,37 @@ switch to a shell.
The string "git " is used as initial input when prompting the user
for the command. It can be removed to run another command.
-- Key: ! s, magit-shell-command-topdir
+- Key: ! s (magit-shell-command-topdir) ::
This command reads a command from the user and executes it in the
top-level directory of the current working tree.
-- Key: ! S, magit-shell-command
+- Key: ! S (magit-shell-command) ::
This command reads a command from the user and executes it in
~default-directory~. With a prefix argument the command is executed
in the top-level directory of the current working tree instead.
-- User Option: magit-shell-command-verbose-prompt
+- User Option: magit-shell-command-verbose-prompt ::
Whether the prompt, used by the above commands when reading a
shell command, shows the directory in which it will be run.
These suffix commands start external gui tools.
-- Key: ! k, magit-run-gitk
+- Key: ! k (magit-run-gitk) ::
This command runs ~gitk~ in the current repository.
-- Key: ! a, magit-run-gitk-all
+- Key: ! a (magit-run-gitk-all) ::
This command runs ~gitk --all~ in the current repository.
-- Key: ! b, magit-run-gitk-branches
+- Key: ! b (magit-run-gitk-branches) ::
This command runs ~gitk --branches~ in the current repository.
-- Key: ! g, magit-run-git-gui
+- Key: ! g (magit-run-git-gui) ::
This command runs ~git gui~ in the current repository.
@@ -1944,14 +1944,14 @@ Tramp, would be problematic to use an absolute path
that is suitable
on the local machine, so a separate option is used to control the name
or path that is used on remote machines.
-- User Option: magit-git-executable
+- User Option: magit-git-executable ::
The ~git~ executable used by Magit on the local host. This should be
either the absolute path to the executable, or the string "git" to
let Emacs find the executable itself, using the standard mechanism
for doing such things.
-- User Option: magit-remote-git-executable
+- User Option: magit-remote-git-executable ::
The ~git~ executable used by Magit on remote machines over Tramp.
Normally this should be just the string "git". Consider customizing
@@ -1973,12 +1973,12 @@ can help; though honestly I consider that a kludge too.
The command ~magit-debug-git-executable~ can be useful to find out where
Emacs is searching for ~git~.
-- Key: M-x magit-debug-git-executable, magit-debug-git-executable
+- Key: M-x magit-debug-git-executable ::
This command displays a buffer with information about
~magit-git-executable~ and ~magit-remote-git-executable~.
-- Key: M-x magit-version, magit-version
+- Key: M-x magit-version ::
This command shows the currently used versions of Magit, Git, and
Emacs in the echo area. Non-interactively this just returns the
@@ -1986,7 +1986,7 @@ Emacs is searching for ~git~.
*** Global Git Arguments
-- User Option: magit-git-global-arguments
+- User Option: magit-git-global-arguments ::
The arguments set here are used every time the git executable is run
as a subprocess. They are placed right after the executable itself
@@ -2037,7 +2037,7 @@ that it should be bound globally. We recommend using
~C-x g~:
(global-set-key (kbd "C-x g") 'magit-status)
#+end_src
-- Key: C-x g, magit-status
+- Key: C-x g (magit-status) ::
When invoked from within an existing Git repository, then this
command shows the status of that repository in a buffer.
@@ -2072,7 +2072,7 @@ that it should be bound globally. We recommend using
~C-x g~:
~magit-repository-directories~, then the behavior is the same as with
two prefix arguments.
-- User Option: magit-repository-directories
+- User Option: magit-repository-directories ::
List of directories that are Git repositories or contain Git
repositories.
@@ -2086,7 +2086,7 @@ that it should be bound globally. We recommend using
~C-x g~:
~magit-list-repositories~. It also affects ~magit-status~ (which see)
in potentially surprising ways (see above).
-- Command: magit-status-quick
+- Command: magit-status-quick ::
This command is an alternative to ~magit-status~ that usually avoids
refreshing the status buffer.
@@ -2114,7 +2114,7 @@ that it should be bound globally. We recommend using
~C-x g~:
It supports displaying any existing Magit buffer that belongs to the
current repository; not just the status buffer.
-- Command: ido-enter-magit-status
+- Command: ido-enter-magit-status ::
From an Ido prompt used to open a file, instead drop into
~magit-status~. This is similar to ~ido-magic-delete-char~, which,
@@ -2144,7 +2144,7 @@ The contents of status buffers is controlled using the
hook
~magit-status-sections-hook~. See [[*Section Hooks]] to learn about such
hooks and how to customize them.
-- User Option: magit-status-sections-hook
+- User Option: magit-status-sections-hook ::
Hook run to insert sections into a status buffer.
@@ -2152,39 +2152,39 @@ The first function on that hook by default is
~magit-insert-status-headers~; it is described in the next section.
By default the following functions are also members of that hook:
-- Function: magit-insert-merge-log
+- Function: magit-insert-merge-log ::
Insert section for the on-going merge. Display the heads that are
being merged. If no merge is in progress, do nothing.
-- Function: magit-insert-rebase-sequence
+- Function: magit-insert-rebase-sequence ::
Insert section for the on-going rebase sequence.
If no such sequence is in progress, do nothing.
-- Function: magit-insert-am-sequence
+- Function: magit-insert-am-sequence ::
Insert section for the on-going patch applying sequence.
If no such sequence is in progress, do nothing.
-- Function: magit-insert-sequencer-sequence
+- Function: magit-insert-sequencer-sequence ::
Insert section for the on-going cherry-pick or revert sequence.
If no such sequence is in progress, do nothing.
-- Function: magit-insert-bisect-output
+- Function: magit-insert-bisect-output ::
While bisecting, insert section with output from ~git bisect~.
-- Function: magit-insert-bisect-rest
+- Function: magit-insert-bisect-rest ::
While bisecting, insert section visualizing the bisect state.
-- Function: magit-insert-bisect-log
+- Function: magit-insert-bisect-log ::
While bisecting, insert section logging bisect progress.
-- Function: magit-insert-untracked-files
+- Function: magit-insert-untracked-files ::
Maybe insert a list or tree of untracked files.
@@ -2193,48 +2193,48 @@ By default the following functions are also members of
that hook:
directories. But the directory sections can then be expanded using
~TAB~.
-- Function: magit-insert-unstaged-changes
+- Function: magit-insert-unstaged-changes ::
Insert section showing unstaged changes.
-- Function: magit-insert-staged-changes
+- Function: magit-insert-staged-changes ::
Insert section showing staged changes.
-- Function: magit-insert-stashes &optional ref heading
+- Function: magit-insert-stashes &optional ref heading ::
Insert the ~stashes~ section showing reflog for "refs/stash".
If optional REF is non-nil show reflog for that instead.
If optional HEADING is non-nil use that as section heading
instead of "Stashes:".
-- Function: magit-insert-unpulled-from-upstream
+- Function: magit-insert-unpulled-from-upstream ::
Insert section showing commits that haven't been pulled from the
upstream branch yet.
-- Function: magit-insert-unpulled-from-pushremote
+- Function: magit-insert-unpulled-from-pushremote ::
Insert section showing commits that haven't been pulled from the
push-remote branch yet.
-- Function: magit-insert-unpushed-to-upstream
+- Function: magit-insert-unpushed-to-upstream ::
Insert section showing commits that haven't been pushed to the
upstream yet.
-- Function: magit-insert-unpushed-to-pushremote
+- Function: magit-insert-unpushed-to-pushremote ::
Insert section showing commits that haven't been pushed to the
push-remote yet.
The following functions can also be added to the above hook:
-- Function: magit-insert-tracked-files
+- Function: magit-insert-tracked-files ::
Insert a tree of tracked files.
-- Function: magit-insert-ignored-files
+- Function: magit-insert-ignored-files ::
Insert a tree of ignored files.
Its possible to limit the logs in the current buffer to a certain
@@ -2245,21 +2245,21 @@ The following functions can also be added to the above
hook:
this function only respects the first of the files and only if it is
a directory.
-- Function: magit-insert-skip-worktree-files
+- Function: magit-insert-skip-worktree-files ::
Insert a tree of skip-worktree files.
If the first element of ~magit-buffer-diff-files~ is a
directory, then limit the list to files below that. The value
of that variable can be set using ~D -- DIRECTORY RET g~.
-- Function: magit-insert-assumed-unchanged-files
+- Function: magit-insert-assumed-unchanged-files ::
Insert a tree of files that are assumed to be unchanged.
If the first element of ~magit-buffer-diff-files~ is a
directory, then limit the list to files below that. The value
of that variable can be set using ~D -- DIRECTORY RET g~.
-- Function: magit-insert-unpulled-or-recent-commits
+- Function: magit-insert-unpulled-or-recent-commits ::
Insert section showing unpulled or recent commits.
If an upstream is configured for the current branch and it is
@@ -2267,18 +2267,18 @@ The following functions can also be added to the above
hook:
Otherwise, show the last ~magit-log-section-commit-count~
commits.
-- Function: magit-insert-recent-commits
+- Function: magit-insert-recent-commits ::
Insert section showing the last ~magit-log-section-commit-count~
commits.
-- User Option: magit-log-section-commit-count
+- User Option: magit-log-section-commit-count ::
How many recent commits ~magit-insert-recent-commits~ and
~magit-insert-unpulled-or-recent-commits~ (provided there are no
unpulled commits) show.
-- Function: magit-insert-unpulled-cherries
+- Function: magit-insert-unpulled-cherries ::
Insert section showing unpulled commits.
Like ~magit-insert-unpulled-commits~ but prefix each commit
@@ -2286,7 +2286,7 @@ The following functions can also be added to the above
hook:
not shared with any local commit) with "+", and all others
with "-".
-- Function: magit-insert-unpushed-cherries
+- Function: magit-insert-unpushed-cherries ::
Insert section showing unpushed commits.
Like ~magit-insert-unpushed-commits~ but prefix each commit
@@ -2305,13 +2305,13 @@ The contents of status buffers is controlled using the
hook
By default ~magit-insert-status-headers~ is the first member of that
hook variable.
-- Function: magit-insert-status-headers
+- Function: magit-insert-status-headers ::
Insert headers sections appropriate for ~magit-status-mode~ buffers.
The sections are inserted by running the functions on the hook
~magit-status-headers-hook~.
-- User Option: magit-status-headers-hook
+- User Option: magit-status-headers-hook ::
Hook run to insert headers sections into the status buffer.
@@ -2320,7 +2320,7 @@ hook variable.
By default the following functions are members of the above hook:
-- Function: magit-insert-error-header
+- Function: magit-insert-error-header ::
Insert a header line showing the message about the Git error that
just occurred.
@@ -2330,36 +2330,36 @@ By default the following functions are members of the
above hook:
generating a diff, then that error won't be inserted. Refreshing
the status buffer causes this section to disappear again.
-- Function: magit-insert-diff-filter-header
+- Function: magit-insert-diff-filter-header ::
Insert a header line showing the effective diff filters.
-- Function: magit-insert-head-branch-header
+- Function: magit-insert-head-branch-header ::
Insert a header line about the current branch or detached ~HEAD~.
-- Function: magit-insert-upstream-branch-header
+- Function: magit-insert-upstream-branch-header ::
Insert a header line about the branch that is usually pulled into
the current branch.
-- Function: magit-insert-push-branch-header
+- Function: magit-insert-push-branch-header ::
Insert a header line about the branch that the current branch is
usually pushed to.
-- Function: magit-insert-tags-header
+- Function: magit-insert-tags-header ::
Insert a header line about the current and/or next tag, along with
the number of commits between the tag and ~HEAD~.
The following functions can also be added to the above hook:
-- Function: magit-insert-repo-header
+- Function: magit-insert-repo-header ::
Insert a header line showing the path to the repository top-level.
-- Function: magit-insert-remote-header
+- Function: magit-insert-remote-header ::
Insert a header line about the remote of the current branch.
@@ -2367,7 +2367,7 @@ The following functions can also be added to the above
hook:
showing the "origin" remote, or if that does not exist the first
remote in alphabetic order.
-- Function: magit-insert-user-header
+- Function: magit-insert-user-header ::
Insert a header line about the current user.
@@ -2379,7 +2379,7 @@ The contents of status buffers is controlled using the
hook
By default ~magit-insert-modules~ is /not/ a member of that hook
variable.
-- Function: magit-insert-modules
+- Function: magit-insert-modules ::
Insert submodule sections.
@@ -2387,11 +2387,11 @@ variable.
inserted, and option ~magit-module-sections-nested~ controls whether
they are wrapped in an additional section.
-- User Option: magit-module-sections-hook
+- User Option: magit-module-sections-hook ::
Hook run by ~magit-insert-modules~.
-- User Option: magit-module-sections-nested
+- User Option: magit-module-sections-nested ::
This option controls whether ~magit-insert-modules~ wraps inserted
sections in an additional section.
@@ -2400,7 +2400,7 @@ variable.
If it is nil, then all sections listed in ~magit-module-sections-hook~
become top-level sections.
-- Function: magit-insert-modules-overview
+- Function: magit-insert-modules-overview ::
Insert sections for all submodules. For each section insert the
path, the branch, and the output of ~git describe --tags~,
@@ -2411,24 +2411,24 @@ variable.
in a separate buffer. This shows additional information not
displayed in the super-repository's status buffer.
-- Function: magit-insert-modules-unpulled-from-upstream
+- Function: magit-insert-modules-unpulled-from-upstream ::
Insert sections for modules that haven't been pulled from the
upstream yet. These sections can be expanded to show the respective
commits.
-- Function: magit-insert-modules-unpulled-from-pushremote
+- Function: magit-insert-modules-unpulled-from-pushremote ::
Insert sections for modules that haven't been pulled from the
push-remote yet. These sections can be expanded to show the
respective commits.
-- Function: magit-insert-modules-unpushed-to-upstream
+- Function: magit-insert-modules-unpushed-to-upstream ::
Insert sections for modules that haven't been pushed to the upstream
yet. These sections can be expanded to show the respective commits.
-- Function: magit-insert-modules-unpushed-to-pushremote
+- Function: magit-insert-modules-unpushed-to-pushremote ::
Insert sections for modules that haven't been pushed to the
push-remote yet. These sections can be expanded to show the
@@ -2436,11 +2436,11 @@ variable.
*** Status Options
-- User Option: magit-status-refresh-hook
+- User Option: magit-status-refresh-hook ::
Hook run after a status buffer has been refreshed.
-- User Option: magit-status-margin
+- User Option: magit-status-margin ::
This option specifies whether the margin is initially shown in
Magit-Status mode buffers and how it is formatted.
@@ -2466,7 +2466,7 @@ buffers.
** Repository List
-- Command: magit-list-repositories
+- Command: magit-list-repositories ::
This command displays a list of repositories in a separate buffer.
@@ -2474,7 +2474,7 @@ buffers.
~magit-repository-directories-depth~ control which repositories are
displayed.
-- User Option: magit-repolist-columns
+- User Option: magit-repolist-columns ::
This option controls what columns are displayed by the command
~magit-list-repositories~ and how they are displayed.
@@ -2496,37 +2496,37 @@ buffers.
The following functions can be added to the above option:
-- Function: magit-repolist-column-ident
+- Function: magit-repolist-column-ident ::
This function inserts the identification of the repository. Usually
this is just its basename.
-- Function: magit-repolist-column-path
+- Function: magit-repolist-column-path ::
This function inserts the absolute path of the repository.
-- Function: magit-repolist-column-version
+- Function: magit-repolist-column-version ::
This function inserts a description of the repository's ~HEAD~ revision.
-- Function: magit-repolist-column-branch
+- Function: magit-repolist-column-branch ::
This function inserts the name of the current branch.
-- Function: magit-repolist-column-upstream
+- Function: magit-repolist-column-upstream ::
This function inserts the name of the upstream branch of the current
branch.
-- Function: magit-repolist-column-branches
+- Function: magit-repolist-column-branches ::
This function inserts the number of branches.
-- Function: magit-repolist-column-stashes
+- Function: magit-repolist-column-stashes ::
This function inserts the number of stashes.
-- Function: magit-repolist-column-flag
+- Function: magit-repolist-column-flag ::
This function inserts a flag as specified by
~magit-repolist-column-flag-alist~.
@@ -2539,22 +2539,22 @@ The following functions can be added to the above
option:
Only the first one of these that applies is shown.
-- Function: magit-repolist-column-unpulled-from-upstream
+- Function: magit-repolist-column-unpulled-from-upstream ::
This function inserts the number of upstream commits not in the
current branch.
-- Function: magit-repolist-column-unpulled-from-pushremote
+- Function: magit-repolist-column-unpulled-from-pushremote ::
This function inserts the number of commits in the push branch but
not the current branch.
-- Function: magit-repolist-column-unpushed-to-upstream
+- Function: magit-repolist-column-unpushed-to-upstream ::
This function inserts the number of commits in the current branch
but not its upstream.
-- Function: magit-repolist-column-unpushed-to-pushremote
+- Function: magit-repolist-column-unpushed-to-pushremote ::
This function inserts the number of commits in the current branch
but not its push branch.
@@ -2579,38 +2579,38 @@ The switch ~++order=VALUE~ is converted to one of
~--author-date-order~,
The log transient also features several reflog commands. See [[*Reflog]].
-- Key: l, magit-log
+- Key: l (magit-log) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
-- Key: l l, magit-log-current
+- Key: l l (magit-log-current) ::
Show log for the current branch. When ~HEAD~ is detached or with a
prefix argument, show log for one or more revs read from the
minibuffer.
-- Key: l o, magit-log-other
+- Key: l o (magit-log-other) ::
Show log for one or more revs read from the minibuffer. The user
can input any revision or revisions separated by a space, or even
ranges, but only branches, tags, and a representation of the
commit at point are available as completion candidates.
-- Key: l h, magit-log-head
+- Key: l h (magit-log-head) ::
Show log for ~HEAD~.
-- Key: l L, magit-log-branches
+- Key: l L (magit-log-branches) ::
Show log for all local branches and ~HEAD~.
-- Key: l b, magit-log-all-branches
+- Key: l b (magit-log-all-branches) ::
Show log for all local and remote branches and ~HEAD~.
-- Key: l a, magit-log-all
+- Key: l a (magit-log-all) ::
Show log for all references and ~HEAD~.
@@ -2626,38 +2626,38 @@ change the log arguments used in the current buffer,
without changing
which log is shown. This works in dedicated log buffers, but also in
the status buffer.
-- Key: L, magit-log-refresh
+- Key: L (magit-log-refresh) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
-- Key: L g, magit-log-refresh
+- Key: L g (magit-log-refresh) ::
This suffix command sets the local log arguments for the current
buffer.
-- Key: L s, magit-log-set-default-arguments
+- Key: L s (magit-log-set-default-arguments) ::
This suffix command sets the default log arguments for buffers of
the same type as that of the current buffer. Other existing buffers
of the same type are not affected because their local values have
already been initialized.
-- Key: L w, magit-log-save-default-arguments
+- Key: L w (magit-log-save-default-arguments) ::
This suffix command sets the default log arguments for buffers of
the same type as that of the current buffer, and saves the value for
future sessions. Other existing buffers of the same type are not
affected because their local values have already been initialized.
-- Key: L t, magit-toggle-margin
+- Key: L t (magit-toggle-margin) ::
Show or hide the margin.
*** Log Buffer
-- Key: L, magit-log-refresh
+- Key: L (magit-log-refresh) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
@@ -2665,28 +2665,28 @@ the status buffer.
See [[*Refreshing Logs]].
-- Key: q, magit-log-bury-buffer
+- Key: q (magit-log-bury-buffer) ::
Bury the current buffer or the revision buffer in the same frame.
Like ~magit-mode-bury-buffer~ (which see) but with a negative prefix
argument instead bury the revision buffer, provided it is displayed
in the current frame.
-- Key: C-c C-b, magit-go-backward
+- Key: C-c C-b (magit-go-backward) ::
Move backward in current buffer's history.
-- Key: C-c C-f, magit-go-forward
+- Key: C-c C-f (magit-go-forward) ::
Move forward in current buffer's history.
-- Key: C-c C-n, magit-log-move-to-parent
+- Key: C-c C-n (magit-log-move-to-parent) ::
Move to a parent of the current commit. By default, this is the
first parent, but a numeric prefix can be used to specify another
parent.
-- Key: j, magit-log-move-to-revision
+- Key: j (magit-log-move-to-revision) ::
Read a revision and move to it in current log buffer.
@@ -2697,7 +2697,7 @@ the status buffer.
If invoked outside any log buffer, then display the log buffer
of the current repository first; creating it if necessary.
-- Key: SPC, magit-diff-show-or-scroll-up
+- Key: SPC (magit-diff-show-or-scroll-up) ::
Update the commit or diff buffer for the thing at point.
@@ -2707,7 +2707,7 @@ the status buffer.
scroll the buffer up. If there is no commit or stash at point, then
prompt for a commit.
-- Key: DEL, magit-diff-show-or-scroll-down
+- Key: DEL (magit-diff-show-or-scroll-down) ::
Update the commit or diff buffer for the thing at point.
@@ -2717,27 +2717,27 @@ the status buffer.
scroll the buffer down. If there is no commit or stash at point,
then prompt for a commit.
-- Key: =, magit-log-toggle-commit-limit
+- Key: = (magit-log-toggle-commit-limit) ::
Toggle the number of commits the current log buffer is limited to.
If the number of commits is currently limited, then remove that
limit. Otherwise set it to 256.
-- Key: +, magit-log-double-commit-limit
+- Key: + (magit-log-double-commit-limit) ::
Double the number of commits the current log buffer is limited to.
-- Key: -, magit-log-half-commit-limit
+- Key: - (magit-log-half-commit-limit) ::
Half the number of commits the current log buffer is limited to.
-- User Option: magit-log-auto-more
+- User Option: magit-log-auto-more ::
Insert more log entries automatically when moving past the last
entry. Only considered when moving past the last entry with
~magit-goto-*-section~ commands.
-- User Option: magit-log-show-refname-after-summary
+- User Option: magit-log-show-refname-after-summary ::
Whether to show the refnames after the commit summaries. This is
useful if you use really long branch names.
@@ -2780,7 +2780,7 @@ used to configure the margin are named
~magit-INFIX-margin~, where INFIX
is the same as in the respective major-mode ~magit-INFIX-mode~. In
regular log buffers that would be ~magit-log-margin~.
-- User Option: magit-log-margin
+- User Option: magit-log-margin ::
This option specifies whether the margin is initially shown in
Magit-Log mode buffers and how it is formatted.
@@ -2810,7 +2810,7 @@ in the default of all other options. But setting it to
~t~, i.e.
re-enforcing the default for that option, does not carry to other
options.
-- User Option: magit-log-margin-show-committer-date
+- User Option: magit-log-margin-show-committer-date ::
This option specifies whether to show the committer date in the
margin. This option only controls whether the committer date is
@@ -2818,7 +2818,7 @@ options.
displayed in the margin and whether the margin is displayed at all
is controlled by other options.
-- Key: L, magit-margin-settings
+- Key: L (magit-margin-settings) ::
This transient prefix command binds the following suffix commands,
each of which changes the appearance of the margin in some way.
@@ -2827,15 +2827,15 @@ In some buffers that support the margin, ~L~ is instead
bound to
~magit-log-refresh~, but that transient features the same commands, and
then some other unrelated commands.
-- Key: L L, magit-toggle-margin
+- Key: L L (magit-toggle-margin) ::
This command shows or hides the margin.
-- Key: L l, magit-cycle-margin-style
+- Key: L l (magit-cycle-margin-style) ::
This command cycles the style used for the margin.
-- Key: L d, magit-toggle-margin-details
+- Key: L d (magit-toggle-margin-details) ::
This command shows or hides details in the margin.
@@ -2855,17 +2855,17 @@ In addition to the key bindings available in all log
buffers, the
following additional key bindings are available in selection log
buffers:
-- Key: C-c C-c, magit-log-select-pick
+- Key: C-c C-c (magit-log-select-pick) ::
Select the commit at point and act on it. Call
~magit-log-select-pick-function~ with the selected commit as
argument.
-- Key: C-c C-k, magit-log-select-quit
+- Key: C-c C-k (magit-log-select-quit) ::
Abort selecting a commit, don't act on any commit.
-- User Option: magit-log-select-margin
+- User Option: magit-log-select-margin ::
This option specifies whether the margin is initially shown in
Magit-Log-Select mode buffers and how it is formatted.
@@ -2893,19 +2893,19 @@ Also see [[man:git-reflog]]
These reflog commands are available from the log transient. See
[[*Logging]].
-- Key: l r, magit-reflog-current
+- Key: l r (magit-reflog-current) ::
Display the reflog of the current branch.
-- Key: l O, magit-reflog-other
+- Key: l O (magit-reflog-other) ::
Display the reflog of a branch or another ref.
-- Key: l H, magit-reflog-head
+- Key: l H (magit-reflog-head) ::
Display the ~HEAD~ reflog.
-- User Option: magit-reflog-margin
+- User Option: magit-reflog-margin ::
This option specifies whether the margin is initially shown in
Magit-Reflog mode buffers and how it is formatted.
@@ -2939,12 +2939,12 @@ multiple "upstreams" at once.
Also see [[man:git-reflog]]
-- Key: Y, magit-cherry
+- Key: Y (magit-cherry) ::
Show commits that are in a certain branch but that have not been
merged in the upstream branch.
-- User Option: magit-cherry-margin
+- User Option: magit-cherry-margin ::
This option specifies whether the margin is initially shown in
Magit-Cherry mode buffers and how it is formatted.
@@ -2981,17 +2981,17 @@ buffer, depending on the value of
~magit-prefix-use-buffer-arguments~
Also see [[man:git-diff]]
-- Key: d, magit-diff
+- Key: d (magit-diff) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
-- Key: d d, magit-diff-dwim
+- Key: d d (magit-diff-dwim) ::
Show changes for the thing at point.
-- Key: d r, magit-diff-range
+- Key: d r (magit-diff-range) ::
Show differences between two commits.
@@ -3005,23 +3005,23 @@ Also see [[man:git-diff]]
revisions, choose a revision to view changes along, starting at the
common ancestor of both revisions (i.e., use a "..." range).
-- Key: d w, magit-diff-working-tree
+- Key: d w (magit-diff-working-tree) ::
Show changes between the current working tree and the ~HEAD~ commit.
With a prefix argument show changes between the working tree and a
commit read from the minibuffer.
-- Key: d s, magit-diff-staged
+- Key: d s (magit-diff-staged) ::
Show changes between the index and the ~HEAD~ commit. With a prefix
argument show changes between the index and a commit read from the
minibuffer.
-- Key: d u, magit-diff-unstaged
+- Key: d u (magit-diff-unstaged) ::
Show changes between the working tree and the index.
-- Key: d p, magit-diff-paths
+- Key: d p (magit-diff-paths) ::
Show changes between any two files on disk.
@@ -3029,12 +3029,12 @@ All of the above suffix commands update the
repository's diff buffer.
The diff transient also features two commands which show differences
in another buffer:
-- Key: d c, magit-show-commit
+- Key: d c (magit-show-commit) ::
Show the commit at point. If there is no commit at point or with a
prefix argument, prompt for a commit.
-- Key: d t, magit-stash-show
+- Key: d t (magit-stash-show) ::
Show all diffs of a stash in a buffer.
@@ -3049,46 +3049,46 @@ change the diff arguments used in the current buffer,
without changing
which diff is shown. This works in dedicated diff buffers, but also
in the status buffer.
-- Key: D, magit-diff-refresh
+- Key: D (magit-diff-refresh) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
-- Key: D g, magit-diff-refresh
+- Key: D g (magit-diff-refresh) ::
This suffix command sets the local diff arguments for the current
buffer.
-- Key: D s, magit-diff-set-default-arguments
+- Key: D s (magit-diff-set-default-arguments) ::
This suffix command sets the default diff arguments for buffers of
the same type as that of the current buffer. Other existing buffers
of the same type are not affected because their local values have
already been initialized.
-- Key: D w, magit-diff-save-default-arguments
+- Key: D w (magit-diff-save-default-arguments) ::
This suffix command sets the default diff arguments for buffers of
the same type as that of the current buffer, and saves the value for
future sessions. Other existing buffers of the same type are not
affected because their local values have already been initialized.
-- Key: D t, magit-diff-toggle-refine-hunk
+- Key: D t (magit-diff-toggle-refine-hunk) ::
This command toggles hunk refinement on or off.
-- Key: D r, magit-diff-switch-range-type
+- Key: D r (magit-diff-switch-range-type) ::
This command converts the diff range type from "revA..revB" to
"revB...revA", or vice versa.
-- Key: D f, magit-diff-flip-revs
+- Key: D f (magit-diff-flip-revs) ::
This command swaps revisions in the diff range from "revA..revB"
to "revB..revA", or vice versa.
-- Key: D F, magit-diff-toggle-file-filter
+- Key: D F (magit-diff-toggle-file-filter) ::
This command toggles the file restriction of the diffs in the
current buffer, allowing you to quickly switch between viewing all
@@ -3102,22 +3102,22 @@ In addition to the above transient, which allows
changing any of the
supported arguments, there also exist some commands that change only
a particular argument.
-- Key: -, magit-diff-less-context
+- Key: - (magit-diff-less-context) ::
This command decreases the context for diff hunks by COUNT lines.
-- Key: +, magit-diff-more-context
+- Key: + (magit-diff-more-context) ::
This command increases the context for diff hunks by COUNT lines.
-- Key: 0, magit-diff-default-context
+- Key: 0 (magit-diff-default-context) ::
This command resets the context for diff hunks to the default height.
The following commands quickly change what diff is being displayed
without having to using one of the diff transient.
-- Key: C-c C-d, magit-diff-while-committing
+- Key: C-c C-d (magit-diff-while-committing) ::
While committing, this command shows the changes that are about to
be committed. While amending, invoking the command again toggles
@@ -3127,11 +3127,11 @@ without having to using one of the diff transient.
This binding is available in the diff buffer as well as the commit
message buffer.
-- Key: C-c C-b, magit-go-backward
+- Key: C-c C-b (magit-go-backward) ::
This command moves backward in current buffer's history.
-- Key: C-c C-f, magit-go-forward
+- Key: C-c C-f (magit-go-forward) ::
This command moves forward in current buffer's history.
@@ -3145,18 +3145,18 @@ version of the file that the diff at point is about.
Likewise
version of the file that the diff at point is about. See [[*Visiting
Files and Blobs from a Diff]] for more information and the key bindings.
-- Key: C-c C-t, magit-diff-trace-definition
+- Key: C-c C-t (magit-diff-trace-definition) ::
This command shows a log for the definition at point.
-- User Option: magit-log-trace-definition-function
+- User Option: magit-log-trace-definition-function ::
The function specified by this option is used by
~magit-log-trace-definition~ to determine the function at point. For
major-modes that have special needs, you could set the local value
using the mode's hook.
-- Key: C-c C-e, magit-diff-edit-hunk-commit
+- Key: C-c C-e (magit-diff-edit-hunk-commit) ::
From a hunk, this command edits the respective commit and visits
the file.
@@ -3176,7 +3176,7 @@ Files and Blobs from a Diff]] for more information and
the key bindings.
the rebase. If that is undesirable, then it might be better to
use ~magit-rebase-edit-command~ instead of this command.
-- Key: j, magit-jump-to-diffstat-or-diff
+- Key: j (magit-jump-to-diffstat-or-diff) ::
This command jumps to the diffstat or diff. When point is on a file
inside the diffstat section, then jump to the respective diff
@@ -3187,17 +3187,17 @@ The next two commands are not specific to Magit-Diff
mode (or and
Magit buffer for that matter), but it might be worth pointing out
that they are available here too.
-- Key: SPC, scroll-up
+- Key: SPC (scroll-up) ::
This command scrolls text upward.
-- Key: DEL, scroll-down
+- Key: DEL (scroll-down) ::
This command scrolls text downward.
*** Diff Options
-- User Option: magit-diff-refine-hunk
+- User Option: magit-diff-refine-hunk ::
Whether to show word-granularity differences within diff hunks.
@@ -3205,12 +3205,12 @@ that they are available here too.
- ~t~ Show fine differences for the current diff hunk only.
- ~all~ Show fine differences for all displayed diff hunks.
-- User Option: magit-diff-refine-ignore-whitespace
+- User Option: magit-diff-refine-ignore-whitespace ::
Whether to ignore whitespace changes in word-granularity
differences.
-- User Option: magit-diff-adjust-tab-width
+- User Option: magit-diff-adjust-tab-width ::
Whether to adjust the width of tabs in diffs.
@@ -3232,7 +3232,7 @@ that they are available here too.
- NUMBER Like ~always~, but don't visit files larger than NUMBER
bytes.
-- User Option: magit-diff-paint-whitespace
+- User Option: magit-diff-paint-whitespace ::
Specify where to highlight whitespace errors.
@@ -3247,7 +3247,7 @@ that they are available here too.
uncommitted changes. For backward compatibility ~status~ is treated
as a synonym.
-- User Option: magit-diff-paint-whitespace-lines
+- User Option: magit-diff-paint-whitespace-lines ::
Specify in what kind of lines to highlight whitespace errors.
@@ -3255,12 +3255,12 @@ that they are available here too.
- ~both~ Highlight in added and removed lines.
- ~all~ Highlight in added, removed and context lines.
-- User Option: magit-diff-highlight-trailing
+- User Option: magit-diff-highlight-trailing ::
Whether to highlight whitespace at the end of a line in diffs. Used
only when ~magit-diff-paint-whitespace~ is non-nil.
-- User Option: magit-diff-highlight-indentation
+- User Option: magit-diff-highlight-indentation ::
This option controls whether to highlight the indentation in case it
used the "wrong" indentation style. Indentation is only highlighted
@@ -3275,11 +3275,11 @@ that they are available here too.
INDENT is an integer, highlight indentation with at least that many
spaces. Otherwise, highlight neither.
-- User Option: magit-diff-hide-trailing-cr-characters
+- User Option: magit-diff-hide-trailing-cr-characters ::
Whether to hide ^M characters at the end of a line in diffs.
-- User Option: magit-diff-highlight-hunk-region-functions
+- User Option: magit-diff-highlight-hunk-region-functions ::
This option specifies the functions used to highlight the
hunk-internal region.
@@ -3304,14 +3304,14 @@ that they are available here too.
and underline variants normally do, so there they fall back to
calling the face function instead.
-- User Option: magit-diff-unmarked-lines-keep-foreground
+- User Option: magit-diff-unmarked-lines-keep-foreground ::
This option controls whether added and removed lines outside the
hunk-internal region only lose their distinct background color or
also the foreground color. Whether the outside of the region is
dimmed at all depends on ~magit-diff-highlight-hunk-region-functions~.
-- User Option: magit-diff-extra-stat-arguments
+- User Option: magit-diff-extra-stat-arguments ::
This option specifies additional arguments to be used alongside
~--stat~.
@@ -3323,7 +3323,7 @@ that they are available here too.
*** Revision Buffer
-- User Option: magit-revision-insert-related-refs
+- User Option: magit-revision-insert-related-refs ::
Whether to show related branches in revision buffers.
@@ -3332,7 +3332,7 @@ that they are available here too.
- ~all~ Show related local and remote branches.
- ~mixed~ Show all containing branches and local merged branches.
-- User Option: magit-revision-show-gravatars
+- User Option: magit-revision-show-gravatars ::
Whether to show gravatar images in revision buffers.
@@ -3349,7 +3349,7 @@ that they are available here too.
same column. The cdr specifies where to insert the committer's
image, accordingly. Either the car or the cdr may be nil."
-- User Option: magit-revision-use-hash-sections
+- User Option: magit-revision-use-hash-sections ::
Whether to turn hashes inside the commit message into sections.
@@ -3373,7 +3373,7 @@ from a log buffer, the revision buffer will share the
same file
restriction as that log buffer (also see the command
~magit-diff-toggle-file-filter~).
-- User Option: magit-revision-filter-files-on-follow
+- User Option: magit-revision-filter-files-on-follow ::
Whether showing a commit from a log buffer honors the log's file
filter when the log arguments include ~--follow~.
@@ -3396,7 +3396,7 @@ Buffer Variables]]).
This section describes how to enter Ediff from Magit buffers. For
information on how to use Ediff itself, see info:ediff.
-- Key: e, magit-ediff-dwim
+- Key: e (magit-ediff-dwim) ::
Compare, stage, or resolve using Ediff.
@@ -3408,12 +3408,12 @@ information on how to use Ediff itself, see info:ediff.
explicitly. If it cannot read the user's mind at all, then it asks
the user for a command to run.
-- Key: E, magit-ediff
+- Key: E (magit-ediff) ::
This transient prefix command binds the following suffix commands
and displays them in a temporary buffer until a suffix is invoked.
-- Key: E r, magit-ediff-compare
+- Key: E r (magit-ediff-compare) ::
Compare two revisions of a file using Ediff.
@@ -3422,7 +3422,7 @@ information on how to use Ediff itself, see info:ediff.
revisions, choose a revision to view changes along, starting at the
common ancestor of both revisions (i.e., use a "..." range).
-- Key: E m, magit-ediff-resolve
+- Key: E m (magit-ediff-resolve) ::
Resolve outstanding conflicts in a file using Ediff, defaulting to
the file at point.
@@ -3435,32 +3435,32 @@ information on how to use Ediff itself, see info:ediff.
including those already resolved by Git, use
~ediff-merge-revisions-with-ancestor~.
-- Key: E s, magit-ediff-stage
+- Key: E s (magit-ediff-stage) ::
Stage and unstage changes to a file using Ediff, defaulting to the
file at point.
-- Key: E u, magit-ediff-show-unstaged
+- Key: E u (magit-ediff-show-unstaged) ::
Show unstaged changes to a file using Ediff.
-- Key: E i, magit-ediff-show-staged
+- Key: E i (magit-ediff-show-staged) ::
Show staged changes to a file using Ediff.
-- Key: E w, magit-ediff-show-working-tree
+- Key: E w (magit-ediff-show-working-tree) ::
Show changes in a file between ~HEAD~ and working tree using Ediff.
-- Key: E c, magit-ediff-show-commit
+- Key: E c (magit-ediff-show-commit) ::
Show changes to a file introduced by a commit using Ediff.
-- Key: E z, magit-ediff-show-stash
+- Key: E z (magit-ediff-show-stash) ::
Show changes to a file introduced by a stash using Ediff.
-- User Option: magit-ediff-dwim-show-on-hunks
+- User Option: magit-ediff-dwim-show-on-hunks ::
This option controls what command ~magit-ediff-dwim~ calls when
point is on uncommitted hunks. When nil, always run
@@ -3468,14 +3468,14 @@ information on how to use Ediff itself, see info:ediff.
~magit-ediff-show-unstaged~ to show staged and unstaged changes,
respectively.
-- User Option: magit-ediff-show-stash-with-index
+- User Option: magit-ediff-show-stash-with-index ::
This option controls whether ~magit-ediff-show-stash~ includes a
buffer containing the file's state in the index at the time the
stash was created. This makes it possible to tell which changes in
the stash were staged.
-- User Option: magit-ediff-quit-hook
+- User Option: magit-ediff-quit-hook ::
This hook is run after quitting an Ediff session that was created
using a Magit command. The hook functions are run inside the Ediff
@@ -3487,7 +3487,7 @@ information on how to use Ediff itself, see info:ediff.
** References Buffer
-- Key: y, magit-show-refs
+- Key: y (magit-show-refs) ::
This command lists branches and tags in a dedicated buffer.
@@ -3502,27 +3502,27 @@ enabled by changing the value of
~magit-refs-show-commit-count~ (see
below). These commands specify a different branch or commit against
which all the other references are compared.
-- Key: y y, magit-show-refs-head
+- Key: y y (magit-show-refs-head) ::
This command lists branches and tags in a dedicated buffer. Each
reference is being compared with ~HEAD~.
-- Key: y c, magit-show-refs-current
+- Key: y c (magit-show-refs-current) ::
This command lists branches and tags in a dedicated buffer. Each
reference is being compared with the current branch or ~HEAD~ if it
is detached.
-- Key: y o, magit-show-refs-other
+- Key: y o (magit-show-refs-other) ::
This command lists branches and tags in a dedicated buffer. Each
reference is being compared with a branch read from the user.
-- Key: y r, magit-refs-set-show-commit-count
+- Key: y r (magit-refs-set-show-commit-count) ::
This command changes for which refs the commit count is shown.
-- User Option: magit-refs-show-commit-count
+- User Option: magit-refs-show-commit-count ::
Whether to show commit counts in Magit-Refs mode buffers.
@@ -3532,7 +3532,7 @@ which all the other references are compared.
The default is ~nil~ because anything else can be very expensive.
-- User Option: magit-refs-pad-commit-counts
+- User Option: magit-refs-pad-commit-counts ::
Whether to pad all commit counts on all sides in Magit-Refs mode
buffers.
@@ -3545,14 +3545,14 @@ which all the other references are compared.
If this is non-nil, then spaces are placed on both sides of all
commit counts.
-- User Option: magit-refs-show-remote-prefix
+- User Option: magit-refs-show-remote-prefix ::
Whether to show the remote prefix in lists of remote branches.
Showing the prefix is redundant because the name of the remote is
already shown in the heading preceding the list of its branches.
-- User Option: magit-refs-primary-column-width
+- User Option: magit-refs-primary-column-width ::
Width of the primary column in `magit-refs-mode' buffers. The
primary column is the column that contains the name of the branch
@@ -3565,7 +3565,7 @@ which all the other references are compared.
the shown local branches. (Remote branches and tags are not taken
into account when calculating to optimal width.)
-- User Option: magit-refs-focus-column-width
+- User Option: magit-refs-focus-column-width ::
Width of the focus column in `magit-refs-mode' buffers.
@@ -3580,7 +3580,7 @@ which all the other references are compared.
which case this option is ignored. Use ~L v~ to change the verbosity
of this column.
-- User Option: magit-refs-margin
+- User Option: magit-refs-margin ::
This option specifies whether the margin is initially shown in
Magit-Refs mode buffers and how it is formatted.
@@ -3601,7 +3601,7 @@ which all the other references are compared.
- AUTHOR-WIDTH has to be an integer. When the name of the author
is shown, then this specifies how much space is used to do so.
-- User Option: magit-refs-margin-for-tags
+- User Option: magit-refs-margin-for-tags ::
This option specifies whether to show information about tags in the
margin. This is disabled by default because it is slow if there are
@@ -3626,7 +3626,8 @@ should also change the others to keep things aligned.
The following
- ~%U~ Upstream of this local branch and additional local vs. upstream
information.
-- User Option: magit-refs-filter-alist
+# new list
+- User Option: magit-refs-filter-alist ::
The purpose of this option is to forgo displaying certain refs
based on their name. If you want to not display any refs of a
@@ -3648,7 +3649,7 @@ should also change the others to keep things aligned.
The following
displayed as just "master", however for this comparison the
former is used.
-- Key: RET, magit-visit-ref
+- Key: RET (magit-visit-ref) ::
This command visits the reference or revision at point in another
buffer. If there is no revision at point or with a prefix argument
@@ -3659,7 +3660,7 @@ should also change the others to keep things aligned.
The following
which case the behavior may be different, but only if you have
customized the option ~magit-visit-ref-behavior~.
-- User Option: magit-visit-ref-behavior
+- User Option: magit-visit-ref-behavior ::
This option controls how ~magit-visit-ref~ behaves in ~magit-refs-mode~
buffers.
@@ -3729,19 +3730,19 @@ the default value. Note that it makes much less sense
to customize
this hook than it does for the respective hook used for the status
buffer.
-- User Option: magit-refs-sections-hook
+- User Option: magit-refs-sections-hook ::
Hook run to insert sections into a references buffer.
-- Function: magit-insert-local-branches
+- Function: magit-insert-local-branches ::
Insert sections showing all local branches.
-- Function: magit-insert-remote-branches
+- Function: magit-insert-remote-branches ::
Insert sections showing all remote-tracking branches.
-- Function: magit-insert-tags
+- Function: magit-insert-tags ::
Insert sections showing all tags.
@@ -3749,7 +3750,7 @@ buffer.
Also see [[man:git-bisect]]
-- Key: B, magit-bisect
+- Key: B (magit-bisect) ::
This transient prefix command binds the following suffix commands
and displays them in a temporary buffer until a suffix is invoked.
@@ -3757,7 +3758,7 @@ Also see [[man:git-bisect]]
When bisecting is not in progress, then the transient features the
following suffix commands.
-- Key: B B, magit-bisect-start
+- Key: B B (magit-bisect-start) ::
Start a bisect session.
@@ -3768,37 +3769,37 @@ following suffix commands.
conceptually more fitting than "bad" and "good", but the infix
arguments to do so are disabled by default.
-- Key: B s, magit-bisect-run
+- Key: B s (magit-bisect-run) ::
Bisect automatically by running commands after each step.
When bisecting in progress, then the transient instead features the
following suffix commands.
-- Key: B b, magit-bisect-bad
+- Key: B b (magit-bisect-bad) ::
Mark the current commit as bad. Use this after you have asserted
that the commit does contain the bug in question.
-- Key: B g, magit-bisect-good
+- Key: B g (magit-bisect-good) ::
Mark the current commit as good. Use this after you have asserted
that the commit does not contain the bug in question.
-- Key: B m, magit-bisect-mark
+- Key: B m (magit-bisect-mark) ::
Mark the current commit with one of the bisect terms. This command
provides an alternative to ~magit-bisect-bad~ and
~magit-bisect-good~ and is useful when using terms other than "bad"
and "good". This suffix is disabled by default.
-- Key: B k, magit-bisect-skip
+- Key: B k (magit-bisect-skip) ::
Skip the current commit. Use this if for some reason the current
commit is not a good one to test. This command lets Git choose a
different one.
-- Key: B r, magit-bisect-reset
+- Key: B r (magit-bisect-reset) ::
After bisecting, cleanup bisection state and return to original
~HEAD~.
@@ -3806,7 +3807,7 @@ following suffix commands.
By default the status buffer shows information about the ongoing
bisect session.
-- User Option: magit-bisect-show-graph
+- User Option: magit-bisect-show-graph ::
This option controls whether a graph is displayed for the log of
commits that still have to be bisected.
@@ -3824,19 +3825,19 @@ These commands can be used anywhere to open any blob.
Currently no
keys are bound to these commands by default, but that is likely to
change.
-- Command: magit-find-file
+- Command: magit-find-file ::
This command reads a filename and revision from the user and visits
the respective blob in a buffer. The buffer is displayed in the
selected window.
-- Command: magit-find-file-other-window
+- Command: magit-find-file-other-window ::
This command reads a filename and revision from the user and visits
the respective blob in a buffer. The buffer is displayed in another
window.
-- Command: magit-find-file-other-frame
+- Command: magit-find-file-other-frame ::
This command reads a filename and revision from the user and visits
the respective blob in a buffer. The buffer is displayed in another
@@ -3846,7 +3847,7 @@ change.
These commands can only be used when point is inside a diff.
-- Key: RET, magit-diff-visit-file
+- Key: RET (magit-diff-visit-file) ::
This command visits the appropriate version of the file that the
diff at point is about.
@@ -3877,7 +3878,7 @@ These commands can only be used when point is inside a
diff.
The buffer is displayed in the selected window. With a prefix
argument the buffer is displayed in another window instead.
-- User Option: magit-diff-visit-previous-blob
+- User Option: magit-diff-visit-previous-blob ::
This option controls whether ~magit-diff-visit-file~ may visit the
previous blob. When this is ~t~ (the default) and point is on a
@@ -3889,7 +3890,7 @@ These commands can only be used when point is inside a
diff.
and unstaged changes ~magit-diff-visit-file~ always visits the file in
the working tree.
-- Key: C-<return>, magit-diff-visit-file-worktree
+- Key: C-<return> (magit-diff-visit-file-worktree) ::
This command visits the worktree version of the appropriate file.
The location of point inside the diff determines which file is being
@@ -3910,10 +3911,10 @@ then you may want to change the above key bindings, but
note that the
above commands also use another window when invoked with a prefix
argument.
-- Command: magit-diff-visit-file-other-window
-- Command: magit-diff-visit-file-other-frame
-- Command: magit-diff-visit-worktree-file-other-window
-- Command: magit-diff-visit-worktree-file-other-frame
+- Command: magit-diff-visit-file-other-window ::
++ Command: magit-diff-visit-file-other-frame ::
++ Command: magit-diff-visit-worktree-file-other-window ::
++ Command: magit-diff-visit-worktree-file-other-frame ::
** Blaming
@@ -3929,7 +3930,7 @@ have to enter the blaming sub-transient first.
The key bindings shown below assume that you enter the dispatch
transient using the default binding.
-- Key: C-c M-g B, magit-blame
+- Key: C-c M-g B (magit-blame) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
@@ -3940,8 +3941,8 @@ times. For example if ~magit-blame-mode~ is not enabled,
then the
command whose purpose is to turn off that mode would not be of any
use and therefore isn't available.
-- Key: C-c M-g b, magit-blame-addition
-- Key: C-c M-g B b, magit-blame-addition
+- Key: C-c M-g b (magit-blame-addition) ::
+- Key: C-c M-g B b ::
This command augments each line or chunk of lines in the current
file-visiting or blob-visiting buffer with information about what
@@ -3956,8 +3957,8 @@ use and therefore isn't available.
~magit-find-file~), where REVISION is a parent of the revision that
added the current line or chunk of lines.
-- Key: C-c M-g r, magit-blame-removal
-- Key: C-c M-g B r, magit-blame-removal
+- Key: C-c M-g r (magit-blame-removal) ::
+- Key: C-c M-g B r ::
This command augments each line or chunk of lines in the current
blob-visiting buffer with information about the revision that
@@ -3965,8 +3966,8 @@ use and therefore isn't available.
Like ~magit-blame-addition~, this command can be used recursively.
-- Key: C-c M-g f, magit-blame-reverse
-- Key: C-c M-g B f, magit-blame-reverse
+- Key: C-c M-g f (magit-blame-reverse) ::
+- Key: C-c M-g B f ::
This command augments each line or chunk of lines in the current
file-visiting or blob-visiting buffer with information about the
@@ -3974,8 +3975,8 @@ use and therefore isn't available.
Like ~magit-blame-addition~, this command can be used recursively.
-- Key: C-c M-g e, magit-blame-echo
-- Key: C-c M-g B e, magit-blame-echo
+- Key: C-c M-g e (magit-blame-echo) ::
+- Key: C-c M-g B e ::
This command is like ~magit-blame-addition~ except that it doesn't
turn on ~read-only-mode~ and that it initially uses the visualization
@@ -3986,11 +3987,11 @@ enabled and Read-Only mode is not enabled. These
commands are also
available in other buffers; here only the behavior is described that
is relevant in file-visiting buffers that are being blamed.
-- Key: RET, magit-show-commit
+- Key: RET (magit-show-commit) ::
This command shows the commit that last touched the line at point.
-- Key: SPC, magit-diff-show-or-scroll-up
+- Key: SPC (magit-diff-show-or-scroll-up) ::
This command updates the commit buffer.
@@ -3999,7 +4000,7 @@ is relevant in file-visiting buffers that are being
blamed.
in the current frame and if that buffer contains information about
that commit, then the buffer is scrolled up instead.
-- Key: DEL, magit-diff-show-or-scroll-down
+- Key: DEL (magit-diff-show-or-scroll-down) ::
This command updates the commit buffer.
@@ -4011,32 +4012,32 @@ is relevant in file-visiting buffers that are being
blamed.
The following key bindings are available when both Magit-Blame mode
and Read-Only mode are enabled.
-- Key: b, magit-blame
+- Key: b (magit-blame) ::
See above.
-- Key: n, magit-blame-next-chunk
+- Key: n (magit-blame-next-chunk) ::
This command moves to the next chunk.
-- Key: N, magit-blame-next-chunk-same-commit
+- Key: N (magit-blame-next-chunk-same-commit) ::
This command moves to the next chunk from the same commit.
-- Key: p, magit-blame-previous-chunk
+- Key: p (magit-blame-previous-chunk) ::
This command moves to the previous chunk.
-- Key: P, magit-blame-previous-chunk-same-commit
+- Key: P (magit-blame-previous-chunk-same-commit) ::
This command moves to the previous chunk from the same commit.
-- Key: q, magit-blame-quit
+- Key: q (magit-blame-quit) ::
This command turns off Magit-Blame mode. If the buffer was created
during a recursive blame, then it also kills the buffer.
-- Key: M-w, magit-blame-copy-hash
+- Key: M-w (magit-blame-copy-hash) ::
This command saves the hash of the current chunk's commit to the
kill ring.
@@ -4044,7 +4045,7 @@ and Read-Only mode are enabled.
When the region is active, the command saves the region's content
instead of the hash, like ~kill-ring-save~ would.
-- Key: c, magit-blame-cycle-style
+- Key: c (magit-blame-cycle-style) ::
This command changes how blame information is visualized in the
current buffer by cycling through the styles specified using the
@@ -4052,41 +4053,41 @@ and Read-Only mode are enabled.
Blaming is also controlled using the following options.
-- User Option: magit-blame-styles
+- User Option: magit-blame-styles ::
This option defines a list of styles used to visualize blame
information. For now see its doc-string to learn more.
-- User Option: magit-blame-echo-style
+- User Option: magit-blame-echo-style ::
This option specifies the blame visualization style used by the
command ~magit-blame-echo~. This must be a symbol that is used as the
identifier for one of the styles defined in ~magit-blame-styles~.
-- User Option: magit-blame-time-format
+- User Option: magit-blame-time-format ::
This option specifies the format string used to display times when
showing blame information.
-- User Option: magit-blame-read-only
+- User Option: magit-blame-read-only ::
This option controls whether blaming a buffer also makes temporarily
read-only.
-- User Option: magit-blame-disable-modes
+- User Option: magit-blame-disable-modes ::
This option lists incompatible minor-modes that should be disabled
temporarily when a buffer contains blame information. They are
enabled again when the buffer no longer shows blame information.
-- User Option: magit-blame-goto-chunk-hook
+- User Option: magit-blame-goto-chunk-hook ::
This hook is run when moving between chunks.
* Manipulating
** Creating Repository
-- Key: I, magit-init
+- Key: I (magit-init) ::
This command initializes a repository and then shows the status
buffer for the new repository.
@@ -4104,7 +4105,7 @@ command, which binds several infix arguments and suffix
commands, or
it can invoke ~git clone~ directly, depending on whether a prefix
argument is used and on the value of ~magit-clone-always-transient~.
-- User Option: magit-clone-always-transient
+- User Option: magit-clone-always-transient ::
This option controls whether the command ~magit-clone~ always acts as
a transient prefix command, regardless of whether a prefix argument
@@ -4112,7 +4113,7 @@ argument is used and on the value of
~magit-clone-always-transient~.
prefix. If ~nil~, then a prefix argument has to be used for it to act
as a transient.
-- Key: C, magit-clone
+- Key: C (magit-clone) ::
This command either acts as a transient prefix command as described
above or does the same thing as ~transient-clone-regular~ as described
@@ -4121,24 +4122,24 @@ argument is used and on the value of
~magit-clone-always-transient~.
If it acts as a transient prefix, then it binds the following suffix
commands and several infix arguments.
-- Key: C C, magit-clone-regular
+- Key: C C (magit-clone-regular) ::
This command creates a regular clone of an existing repository.
The repository and the target directory are read from the user.
-- Key: C s, magit-clone-shallow
+- Key: C s (magit-clone-shallow) ::
This command creates a shallow clone of an existing repository.
The repository and the target directory are read from the user.
By default the depth of the cloned history is a single commit,
but with a prefix argument the depth is read from the user.
-- Key: C b, magit-clone-bare
+- Key: C b (magit-clone-bare) ::
This command creates a bare clone of an existing repository.
The repository and the target directory are read from the user.
-- Key: C m, magit-clone-mirror
+- Key: C m (magit-clone-mirror) ::
This command creates a mirror of an existing repository.
The repository and the target directory are read from the user.
@@ -4146,21 +4147,21 @@ argument is used and on the value of
~magit-clone-always-transient~.
The following suffixes are disabled by default. See
[[info:transient#Enabling and Disabling Suffixes]] for how to enable them.
-- Key: C d, magit-clone-shallow-since
+- Key: C d (magit-clone-shallow-since) ::
This command creates a shallow clone of an existing repository.
Only commits that were committed after a date are cloned, which
is read from the user. The repository and the target directory
are also read from the user.
-- Key: C e, magit-clone-shallow-exclude
+- Key: C e (magit-clone-shallow-exclude) ::
This command creates a shallow clone of an existing repository.
This reads a branch or tag from the user. Commits that are
reachable from that are not cloned. The repository and the target
directory are also read from the user.
-- User Option: magit-clone-set-remote-head
+- User Option: magit-clone-set-remote-head ::
This option controls whether cloning causes the reference
~refs/remotes/<remote>/HEAD~ to be created in the clone. The default
@@ -4170,7 +4171,7 @@ The following suffixes are disabled by default. See
of the remote changes. Setting this option to ~t~ preserves Git's
default behavior of creating the reference.
-- User Option: magit-clone-set-remote.pushDefault
+- User Option: magit-clone-set-remote.pushDefault ::
This option controls whether the value of the Git variable
~remote.pushDefault~ is set after cloning.
@@ -4180,7 +4181,7 @@ The following suffixes are disabled by default. See
repository.
- If ~nil~, then it is never set.
-- User Option: magit-clone-default-directory
+- User Option: magit-clone-default-directory ::
This option control the default directory name used when reading the
destination for a cloning operation.
@@ -4190,7 +4191,7 @@ The following suffixes are disabled by default. See
- If a function, then that is called with the remote url as the only
argument and the returned value is used.
-- User Option: magit-clone-name-alist
+- User Option: magit-clone-name-alist ::
This option maps regular expressions, which match repository names,
to repository urls, making it possible for users to enter short
@@ -4211,7 +4212,7 @@ The following suffixes are disabled by default. See
value of that is used as the username. Otherwise it is used as the
username itself.
-- User Option: magit-clone-url-format
+- User Option: magit-clone-url-format ::
The format specified by this option is used when turning repository
names into urls. ~%h~ is the hostname and ~%n~ is the repository name,
@@ -4241,7 +4242,7 @@ apply variants are described in the next section.
You can also use Ediff to stage and unstage. See [[*Ediffing]].
-- Key: s, magit-stage
+- Key: s (magit-stage) ::
Add the change at point to the staging area.
@@ -4249,14 +4250,14 @@ You can also use Ediff to stage and unstage. See
[[*Ediffing]].
stage the file but not its content. This makes it possible to stage
only a subset of the new file's changes.
-- Key: S, magit-stage-modified
+- Key: S (magit-stage-modified) ::
Stage all changes to files modified in the worktree. Stage all new
content of tracked files and remove tracked files that no longer
exist in the working tree from the index also. With a prefix
argument also stage previously untracked (but not ignored) files.
-- Key: u, magit-unstage
+- Key: u (magit-unstage) ::
Remove the change at point from the staging area.
@@ -4265,17 +4266,17 @@ You can also use Ediff to stage and unstage. See
[[*Ediffing]].
called on a committed change: it reverses the change in the index
but not in the working tree.
-- Key: U, magit-unstage-all
+- Key: U (magit-unstage-all) ::
Remove all changes from the staging area.
-- User Option: magit-unstage-committed
+- User Option: magit-unstage-committed ::
This option controls whether ~magit-unstage~ "unstages" committed
changes by reversing them in the index but not the working tree.
The alternative is to raise an error.
-- Key: M-x magit-reverse-in-index, magit-reverse-in-index
+- Key: M-x magit-reverse-in-index ::
This command reverses the committed change at point in the index but
not the working tree. By default no key is bound directly to this
@@ -4296,7 +4297,7 @@ You can also use Ediff to stage and unstage. See
[[*Ediffing]].
4. Optionally stage the remaining changes using ~s~ or ~S~ and then
type ~c c~ to create a new commit.
-- Key: M-x magit-reset-index, magit-reset-index
+- Key: M-x magit-reset-index ::
Reset the index to some commit. The commit is read from the user
and defaults to the commit at point. If there is no commit at
@@ -4308,7 +4309,7 @@ Fine-grained un-/staging has to be done from the status
or a diff
buffer, but it's also possible to un-/stage all changes made to the
file visited in the current buffer right from inside that buffer.
-- Key: M-x magit-stage-file, magit-stage-file
+- Key: M-x magit-stage-file ::
When invoked inside a file-visiting buffer, then stage all changes
to that file. In a Magit buffer, stage the file at point if any.
@@ -4316,7 +4317,7 @@ file visited in the current buffer right from inside that
buffer.
always prompt the user for a file, even in a file-visiting buffer or
when there is a file section at point.
-- Key: M-x magit-unstage-file, magit-unstage-file
+- Key: M-x magit-unstage-file ::
When invoked inside a file-visiting buffer, then unstage all changes
to that file. In a Magit buffer, unstage the file at point if any.
@@ -4352,14 +4353,14 @@ The previous section described the staging and
unstaging commands.
What follows are the commands which implement the remaining apply
variants.
-- Key: a, magit-apply
+- Key: a (magit-apply) ::
Apply the change at point to the working tree.
With a prefix argument fallback to a 3-way merge. Doing so causes
the change to be applied to the index as well.
-- Key: k, magit-discard
+- Key: k (magit-discard) ::
Remove the change at point from the working tree.
@@ -4367,7 +4368,7 @@ variants.
keep (while discarding the other). If point is within the text
of a side, then keep that side without prompting.
-- Key: v, magit-reverse
+- Key: v (magit-reverse) ::
Reverse the change at point in the working tree.
@@ -4390,22 +4391,22 @@ commit using the file's content as message.
Also see [[man:git-commit]]
-- Key: c, magit-commit
+- Key: c (magit-commit) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
-- Key: c c, magit-commit-create
+- Key: c c (magit-commit-create) ::
Create a new commit on ~HEAD~. With a prefix argument amend to the
commit at ~HEAD~ instead.
-- Key: c a, magit-commit-amend
+- Key: c a (magit-commit-amend) ::
Amend the last commit.
-- Key: c e, magit-commit-extend
+- Key: c e (magit-commit-extend) ::
Amend the last commit, without editing the message. With a prefix
argument keep the committer date, otherwise change it. The option
@@ -4415,7 +4416,7 @@ Also see [[man:git-commit]]
Non-interactively respect the optional OVERRIDE-DATE argument and
ignore the option.
-- Key: c w, magit-commit-reword
+- Key: c w (magit-commit-reword) ::
Reword the last commit, ignoring staged changes. With a prefix
argument keep the committer date, otherwise change it. The option
@@ -4425,7 +4426,7 @@ Also see [[man:git-commit]]
Non-interactively respect the optional OVERRIDE-DATE argument and
ignore the option.
-- Key: c f, magit-commit-fixup
+- Key: c f (magit-commit-fixup) ::
Create a fixup commit.
@@ -4433,11 +4434,11 @@ Also see [[man:git-commit]]
Otherwise the commit at point may be used without confirmation
depending on the value of option ~magit-commit-squash-confirm~.
-- Key: c F, magit-commit-instant-fixup
+- Key: c F (magit-commit-instant-fixup) ::
Create a fixup commit and instantly rebase.
-- Key: c s, magit-commit-squash
+- Key: c s (magit-commit-squash) ::
Create a squash commit, without editing the squash message.
@@ -4445,11 +4446,11 @@ Also see [[man:git-commit]]
Otherwise the commit at point may be used without confirmation
depending on the value of option ~magit-commit-squash-confirm~.
-- Key: c S, magit-commit-instant-squash
+- Key: c S (magit-commit-instant-squash) ::
Create a squash commit and instantly rebase.
-- Key: c A, magit-commit-augment
+- Key: c A (magit-commit-augment) ::
Create a squash commit, editing the squash message.
@@ -4457,24 +4458,24 @@ Also see [[man:git-commit]]
Otherwise the commit at point may be used without confirmation
depending on the value of option ~magit-commit-squash-confirm~.
-- User Option: magit-commit-ask-to-stage
+- User Option: magit-commit-ask-to-stage ::
Whether to ask to stage all unstaged changes when committing and nothing is
staged.
-- User Option: magit-commit-show-diff
+- User Option: magit-commit-show-diff ::
Whether the relevant diff is automatically shown when committing.
-- User Option: magit-commit-extend-override-date
+- User Option: magit-commit-extend-override-date ::
Whether using ~magit-commit-extend~ changes the committer date.
-- User Option: magit-commit-reword-override-date
+- User Option: magit-commit-reword-override-date ::
Whether using ~magit-commit-reword~ changes the committer date.
-- User Option: magit-commit-squash-confirm
+- User Option: magit-commit-squash-confirm ::
Whether the commit targeted by squash and fixup has to be confirmed.
When non-nil then the commit at point (if any) is used as default
@@ -4483,7 +4484,7 @@ Also see [[man:git-commit]]
always require confirmation because making an error while using
those is harder to recover from.
-- User Option: magit-post-commit-hook
+- User Option: magit-post-commit-hook ::
Hook run after creating a commit without the user editing a message.
@@ -4494,7 +4495,7 @@ Also see [[man:git-commit]]
Also see ~git-commit-post-finish-hook~.
-- User Option: magit-commit-diff-inhibit-same-window
+- User Option: magit-commit-diff-inhibit-same-window ::
Whether to inhibit use of same window when showing diff while
committing.
@@ -4534,12 +4535,12 @@ If the editor returns with a non-zero exit status then
~git~ does not
create the commit. So the most important commands are those for
finishing and aborting the commit.
-- Key: C-c C-c, with-editor-finish
+- Key: C-c C-c (with-editor-finish) ::
Finish the current editing session by returning with exit code 0.
Git then creates the commit using the message it finds in the file.
-- Key: C-c C-k, with-editor-cancel
+- Key: C-c C-k (with-editor-cancel) ::
Cancel the current editing session by returning with exit code 1.
Git then cancels the commit, but leaves the file untouched.
@@ -4550,17 +4551,17 @@ is stored at the beginning and the end of an edit
session (regardless
of whether the session is finished successfully or was canceled). It
is sometimes useful to bring back messages from that ring.
-- Key: C-c M-s, git-commit-save-message
+- Key: C-c M-s (git-commit-save-message) ::
Save the current buffer content to the commit message ring.
-- Key: M-p, git-commit-prev-message
+- Key: M-p (git-commit-prev-message) ::
Cycle backward through the commit message ring, after saving the
current message to the ring. With a numeric prefix ARG, go back
ARG comments.
-- Key: M-n, git-commit-next-message
+- Key: M-n (git-commit-next-message) ::
Cycle forward through the commit message ring, after saving the
current message to the ring. With a numeric prefix ARG, go back
@@ -4574,7 +4575,7 @@ When amending to an existing commit it may be useful to
show either
the changes that are about to be added to that commit or to show those
changes alongside those that have already been committed.
-- Key: C-c C-d, magit-diff-while-committing
+- Key: C-c C-d (magit-diff-while-committing) ::
While committing, show the changes that are about to be committed.
While amending, invoking the command again toggles between showing
@@ -4582,7 +4583,7 @@ changes alongside those that have already been committed.
**** Using the Revision Stack
-- Key: C-c C-w, magit-pop-revision-stack
+- Key: C-c C-w (magit-pop-revision-stack) ::
This command inserts a representation of a revision into the current
buffer. It can be used inside buffers used to write commit messages
@@ -4611,7 +4612,7 @@ changes alongside those that have already been committed.
stack, or with two prefix arguments, then read the repository in
the minibuffer too.
-- User Option: magit-pop-revision-stack-format
+- User Option: magit-pop-revision-stack-format ::
This option controls how the command ~magit-pop-revision-stack~
inserts a revision into the current buffer.
@@ -4644,40 +4645,40 @@ changes alongside those that have already been
committed.
Some projects use pseudo headers in commit messages. Magit colorizes
such headers and provides some commands to insert such headers.
-- User Option: git-commit-known-pseudo-headers
+- User Option: git-commit-known-pseudo-headers ::
A list of Git pseudo headers to be highlighted.
-- Key: C-c C-i, git-commit-insert-pseudo-header
+- Key: C-c C-i (git-commit-insert-pseudo-header) ::
Insert a commit message pseudo header.
-- Key: C-c C-a, git-commit-ack
+- Key: C-c C-a (git-commit-ack) ::
Insert a header acknowledging that you have looked at the commit.
-- Key: C-c C-r, git-commit-review
+- Key: C-c C-r (git-commit-review) ::
Insert a header acknowledging that you have reviewed the commit.
-- Key: C-c C-s, git-commit-signoff
+- Key: C-c C-s (git-commit-signoff) ::
Insert a header to sign off the commit.
-- Key: C-c C-t, git-commit-test
+- Key: C-c C-t (git-commit-test) ::
Insert a header acknowledging that you have tested the commit.
-- Key: C-c C-o, git-commit-cc
+- Key: C-c C-o (git-commit-cc) ::
Insert a header mentioning someone who might be interested.
-- Key: C-c C-p, git-commit-reported
+- Key: C-c C-p (git-commit-reported) ::
Insert a header mentioning the person who reported the issue being
fixed by the commit.
-- Key: C-c M-i, git-commit-suggested
+- Key: C-c M-i (git-commit-suggested) ::
Insert a header mentioning the person who suggested the change.
@@ -4689,7 +4690,7 @@ in buffers used to edit commit messages. It is even
possible to use
different major modes in different repositories, which is useful when
different projects impose different commit message conventions.
-- User Option: git-commit-major-mode
+- User Option: git-commit-major-mode ::
The value of this option is the major mode used to edit Git commit
messages.
@@ -4700,33 +4701,33 @@ happens in the function ~git-commit-setup~, which among
other things runs
the hook ~git-commit-setup-hook~.
-- User Option: git-commit-setup-hook
+- User Option: git-commit-setup-hook ::
Hook run at the end of ~git-commit-setup~.
#+texinfo: @noindent
The following functions are suitable for this hook:
-- Function: git-commit-save-message
+- Function: git-commit-save-message ::
Save the current buffer content to the commit message ring.
-- Function: git-commit-setup-changelog-support
+- Function: git-commit-setup-changelog-support ::
After this function is called, ChangeLog entries are treated as
paragraphs.
-- Function: git-commit-turn-on-auto-fill
+- Function: git-commit-turn-on-auto-fill ::
Turn on ~auto-fill-mode~ and set ~fill-column~ to the value of
~git-commit-fill-column~.
-- Function: git-commit-turn-on-flyspell
+- Function: git-commit-turn-on-flyspell ::
Turn on Flyspell mode. Also prevent comments from being checked and
finally check current non-comment text.
-- Function: git-commit-propertize-diff
+- Function: git-commit-propertize-diff ::
Propertize the diff shown inside the commit message buffer. Git
inserts such diffs into the commit message template when the
@@ -4735,15 +4736,15 @@ The following functions are suitable for this hook:
more useful. But some users disagree, which is why this function
exists.
-- Function: bug-reference-mode
+- Function: bug-reference-mode ::
Hyperlink bug references in the buffer.
-- Function: with-editor-usage-message
+- Function: with-editor-usage-message ::
Show usage information in the echo area.
-- User Option: git-commit-setup-hook
+- User Option: git-commit-setup-hook ::
Hook run after the user finished writing a commit message.
@@ -4769,18 +4770,18 @@ course be turned off, but the result of doing that
usually is that
instead of some code it's now the human who is reviewing your commits
who has to waste some time telling you to fix your commits.
-- User Option: git-commit-summary-max-length
+- User Option: git-commit-summary-max-length ::
The intended maximal length of the summary line of commit messages.
Characters beyond this column are colorized to indicate that this
preference has been violated.
-- User Option: git-commit-fill-column
+- User Option: git-commit-fill-column ::
Column beyond which automatic line-wrapping should happen in commit
message buffers.
-- User Option: git-commit-finish-query-functions
+- User Option: git-commit-finish-query-functions ::
List of functions called to query before performing commit.
@@ -4796,13 +4797,13 @@ who has to waste some time telling you to fix your
commits.
By default the only member is ~git-commit-check-style-conventions~.
-- Function: git-commit-check-style-conventions
+- Function: git-commit-check-style-conventions ::
This function checks for violations of certain basic style
conventions. For each violation it asks users if they want to
proceed anyway.
-- User Option: git-commit-style-convention-checks
+- User Option: git-commit-style-convention-checks ::
This option controls what conventions the function by the same name
tries to enforce. The value is a list of self-explanatory symbols
@@ -4865,7 +4866,7 @@ command deals with branches themselves, not with the
commits reachable
from them. Those features are available from separate transient
command.
-- Key: b, magit-branch
+- Key: b (magit-branch) ::
This transient prefix command binds the following suffix commands
and displays them in a temporary buffer until a suffix is invoked.
@@ -4873,7 +4874,7 @@ command.
By default it also binds and displays the values of some
branch-related Git variables and allows changing their values.
-- User Option: magit-branch-direct-configure
+- User Option: magit-branch-direct-configure ::
This option controls whether the transient command ~magit-branch~ can
be used to directly change the values of Git variables. This defaults
@@ -4882,10 +4883,10 @@ command.
command ~magit-branch-configure~ has to be used instead to view and
change branch related variables.
-- Key: b C, magit-branch-configure
-- Key: f C, magit-branch-configure
-- Key: F C, magit-branch-configure
-- Key: P C, magit-branch-configure
+- Key: b C (magit-branch-configure) ::
++ Key: f C ::
++ Key: F C ::
++ Key: P C ::
This transient prefix command binds commands that set the value of
branch-related variables and displays them in a temporary buffer
@@ -4902,7 +4903,7 @@ command.
The variables are described in [[*Branch Git Variables]].
-- Key: b b, magit-checkout
+- Key: b b (magit-checkout) ::
Checkout a revision read in the minibuffer and defaulting to the
branch or arbitrary revision at point. If the revision is a local
@@ -4910,7 +4911,7 @@ The variables are described in [[*Branch Git Variables]].
else then ~HEAD~ becomes detached. Checkout fails if the working tree
or the staging area contain changes.
-- Key: b n, magit-branch-create
+- Key: b n (magit-branch-create) ::
Create a new branch. The user is asked for a branch or arbitrary
revision to use as the starting point of the new branch. When a
@@ -4920,14 +4921,14 @@ The variables are described in [[*Branch Git
Variables]].
Also see option ~magit-branch-prefer-remote-upstream~.
-- Key: b c, magit-branch-and-checkout
+- Key: b c (magit-branch-and-checkout) ::
This command creates a new branch like ~magit-branch-create~, but then
also checks it out.
Also see option ~magit-branch-prefer-remote-upstream~.
-- Key: b l, magit-branch-checkout
+- Key: b l (magit-branch-checkout) ::
This command checks out an existing or new local branch. It reads a
branch name from the user offering all local branches and a subset
@@ -4949,7 +4950,7 @@ The variables are described in [[*Branch Git Variables]].
to the chosen starting point or something else depends on the value
of ~magit-branch-adjust-remote-upstream-alist~.
-- Key: b s, magit-branch-spinoff
+- Key: b s (magit-branch-spinoff) ::
This command creates and checks out a new branch starting at and
tracking the current branch. That branch in turn is reset to the
@@ -4978,13 +4979,13 @@ The variables are described in [[*Branch Git
Variables]].
branch. If FROM is not reachable from ~HEAD~ or is reachable from the
source branch's upstream, then an error is raised.
-- Key: b S, magit-branch-spinout
+- Key: b S (magit-branch-spinout) ::
This command behaves like ~magit-branch-spinoff~, except that it does
not change the current branch. If there are any uncommitted changes,
then it behaves exactly like ~magit-branch-spinoff~.
-- Key: b x, magit-branch-reset
+- Key: b x (magit-branch-reset) ::
This command resets a branch, defaulting to the branch at point, to
the tip of another branch or any other commit.
@@ -5000,25 +5001,25 @@ The variables are described in [[*Branch Git
Variables]].
the target branch is set as the upstream of the branch that is being
reset.
-- Key: b k, magit-branch-delete
+- Key: b k (magit-branch-delete) ::
Delete one or multiple branches. If the region marks multiple
branches, then offer to delete those. Otherwise, prompt for a single
branch to be deleted, defaulting to the branch at point.
-- Key: b r, magit-branch-rename
+- Key: b r (magit-branch-rename) ::
Rename a branch. The branch and the new name are read in the
minibuffer. With prefix argument the branch is renamed even if that
name conflicts with an existing branch.
-- User Option: magit-branch-read-upstream-first
+- User Option: magit-branch-read-upstream-first ::
When creating a branch, whether to read the upstream branch before
the name of the branch that is to be created. The default is ~t~,
and I recommend you leave it at that.
-- User Option: magit-branch-prefer-remote-upstream
+- User Option: magit-branch-prefer-remote-upstream ::
This option specifies whether remote upstreams are favored over
local upstreams when creating new branches.
@@ -5067,7 +5068,7 @@ The variables are described in [[*Branch Git Variables]].
prefer the former, then you should add branches such as ~master~,
~next~, and ~maint~ to the value of this options.
-- User Option: magit-branch-adjust-remote-upstream-alist
+- User Option: magit-branch-adjust-remote-upstream-alist ::
The value of this option is an alist of branches to be used as
the upstream when branching a remote branch.
@@ -5129,12 +5130,12 @@ you should also account for other common names:
("master" . ("main" "master" "next" "maint")))
#+END_SRC
-- Command: magit-branch-orphan
+- Command: magit-branch-orphan ::
This command creates and checks out a new orphan branch with
contents from a given revision.
-- Command: magit-branch-or-checkout
+- Command: magit-branch-or-checkout ::
This command is a hybrid between ~magit-checkout~ and
~magit-branch-and-checkout~ and is intended as a replacement for the
@@ -5162,19 +5163,19 @@ These variables can be set from the transient prefix
command
~magit-branch-configure~. By default they can also be set from
~magit-branch~. See [[*Branch Commands]].
-- Variable: branch.NAME.merge
+- Variable: branch.NAME.merge ::
Together with ~branch.NAME.remote~ this variable defines the upstream
branch of the local branch named NAME. The value of this variable
is the full reference of the upstream /branch/.
-- Variable: branch.NAME.remote
+- Variable: branch.NAME.remote ::
Together with ~branch.NAME.merge~ this variable defines the upstream
branch of the local branch named NAME. The value of this variable
is the name of the upstream /remote/.
-- Variable: branch.NAME.rebase
+- Variable: branch.NAME.rebase ::
This variable controls whether pulling into the branch named NAME is
done by rebasing or by merging the fetched branch.
@@ -5184,7 +5185,7 @@ These variables can be set from the transient prefix
command
- When undefined then the value of ~pull.rebase~ is used. The default
of that variable is ~false~.
-- Variable: branch.NAME.pushRemote
+- Variable: branch.NAME.pushRemote ::
This variable specifies the remote that the branch named NAME is
usually pushed to. The value has to be the name of an existing
@@ -5198,7 +5199,7 @@ These variables can be set from the transient prefix
command
then the value of the latter is used. By default ~remote.pushDefault~
is undefined.
-- Variable: branch.NAME.description
+- Variable: branch.NAME.description ::
This variable can be used to describe the branch named NAME. That
description is used e.g. when turning the branch into a series of
@@ -5207,7 +5208,7 @@ These variables can be set from the transient prefix
command
The following variables specify defaults which are used if the above
branch-specific variables are not set.
-- Variable: pull.rebase
+- Variable: pull.rebase ::
This variable specifies whether pulling is done by rebasing or by
merging. It can be overwritten using ~branch.NAME.rebase~.
@@ -5220,7 +5221,7 @@ branch-specific variables are not set.
should consider setting this to ~true~, and ~branch.master.rebase~ to
~false~.
-- Variable: remote.pushDefault
+- Variable: remote.pushDefault ::
This variable specifies what remote the local branches are usually
pushed to. This can be overwritten per branch using
@@ -5230,7 +5231,7 @@ The following variables are used during the creation of a
branch and
control whether the various branch-specific variables are
automatically set at this time.
-- Variable: branch.autoSetupMerge
+- Variable: branch.autoSetupMerge ::
This variable specifies under what circumstances creating a branch
NAME should result in the variables ~branch.NAME.merge~ and
@@ -5244,7 +5245,7 @@ automatically set at this time.
point is a remote branch, but not when it is a local branch.
- When ~false~ then the variables are never set.
-- Variable: branch.autoSetupRebase
+- Variable: branch.autoSetupRebase ::
This variable specifies whether creating a branch NAME should result
in the variable ~branch.NAME.rebase~ being set to ~true~.
@@ -5269,7 +5270,7 @@ line, e.g.:
For more information about these variables you should also see
man:git-config Also see [[man:git-branch]], [[man:git-checkout]] and
[[*Pushing]].
-- User Option: magit-prefer-remote-upstream
+- User Option: magit-prefer-remote-upstream ::
This option controls whether commands that read a branch from the
user and then set it as the upstream branch, offer a local or a
@@ -5285,7 +5286,7 @@ man:git-config Also see [[man:git-branch]],
[[man:git-checkout]] and [[*Pushing]
These commands are not available from the transient ~magit-branch~ by
default.
-- Command: magit-branch-shelve
+- Command: magit-branch-shelve ::
This command shelves a branch. This is done by deleting the branch,
and creating a new reference "refs/shelved/BRANCH-NAME" pointing at
@@ -5295,7 +5296,7 @@ default.
This is useful if you want to move a branch out of sight, but are
not ready to completely discard it yet.
-- Command: magit-branch-unshelve
+- Command: magit-branch-unshelve ::
This command unshelves a branch that was previously shelved using
~magit-branch-shelve~. This is done by deleting the reference
@@ -5309,7 +5310,7 @@ default.
Also see [[man:git-merge]] For information on how to resolve
merge conflicts see the next section.
-- Key: m, magit-merge
+- Key: m (magit-merge) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
@@ -5318,7 +5319,7 @@ merge conflicts see the next section.
When no merge is in progress, then the transient features the
following suffix commands.
-- Key: m m, magit-merge-plain
+- Key: m m (magit-merge-plain) ::
This command merges another branch or an arbitrary revision into the
current branch. The branch or revision to be merged is read in the
@@ -5331,21 +5332,21 @@ following suffix commands.
merge commit, which makes it possible to inspect how conflicts were
resolved and to adjust the commit message.
-- Key: m e, magit-merge-editmsg
+- Key: m e (magit-merge-editmsg) ::
This command merges another branch or an arbitrary revision into the
current branch and opens a commit message buffer, so that the user
can make adjustments. The commit is not actually created until the
user finishes with ~C-c C-c~.
-- Key: m n, magit-merge-nocommit
+- Key: m n (magit-merge-nocommit) ::
This command merges another branch or an arbitrary revision into the
current branch, but does not actually create the merge commit. The
user can then further adjust the merge, even when automatic conflict
resolution succeeded and/or adjust the commit message.
-- Key: m a, magit-merge-absorb
+- Key: m a (magit-merge-absorb) ::
This command merges another local branch into the current branch and
then removes the former.
@@ -5357,7 +5358,7 @@ following suffix commands.
Finally, if ~magit-branch-pull-request~ was used to create the merged
branch, then the respective remote branch is also removed.
-- Key: m i, magit-merge-into
+- Key: m i (magit-merge-into) ::
This command merges the current branch into another local branch and
then removes the former. The latter becomes the new current branch.
@@ -5369,7 +5370,7 @@ following suffix commands.
Finally, if ~magit-branch-pull-request~ was used to create the merged
branch, then the respective remote branch is also removed.
-- Key: m s, magit-merge-squash
+- Key: m s (magit-merge-squash) ::
This command squashes the changes introduced by another branch or an
arbitrary revision into the current branch. This only applies the
@@ -5377,7 +5378,7 @@ following suffix commands.
that would allow creating an actual merge commit. Instead of this
command you should probably use a command from the apply transient.
-- Key: m p, magit-merge-preview
+- Key: m p (magit-merge-preview) ::
This command shows a preview of merging another branch or an
arbitrary revision into the current branch.
@@ -5385,12 +5386,12 @@ following suffix commands.
When a merge is in progress, then the transient instead features the
following suffix commands.
-- Key: m m, magit-merge
+- Key: m m (magit-merge) ::
After the user resolved conflicts, this command proceeds with the
merge. If some conflicts weren't resolved, then this command fails.
-- Key: m a, magit-merge-abort
+- Key: m a (magit-merge-abort) ::
This command aborts the current merge operation.
@@ -5519,7 +5520,7 @@ truly complex conflicts, the latter is usually overkill.
Also see [[man:git-rebase]] For information on how to resolve
conflicts that occur during rebases see the preceding section.
-- Key: r, magit-rebase
+- Key: r (magit-rebase) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
@@ -5538,7 +5539,7 @@ See [[*Information About In-Progress Rebase]].
For information about the upstream and the push-remote, see [[*The Two
Remotes]].
-- Key: r p, magit-rebase-onto-pushremote
+- Key: r p (magit-rebase-onto-pushremote) ::
This command rebases the current branch onto its push-remote.
@@ -5546,7 +5547,7 @@ Remotes]].
configured or unusable, then let the user first configure the
push-remote.
-- Key: r u, magit-rebase-onto-upstream
+- Key: r u (magit-rebase-onto-upstream) ::
This command rebases the current branch onto its upstream branch.
@@ -5554,13 +5555,13 @@ Remotes]].
configured or unusable, then let the user first configure
the upstream.
-- Key: r e, magit-rebase-branch
+- Key: r e (magit-rebase-branch) ::
This command rebases the current branch onto a branch read in the
minibuffer. All commits that are reachable from head but not from
the selected branch TARGET are being rebased.
-- Key: r s, magit-rebase-subset
+- Key: r s (magit-rebase-subset) ::
This command starts a non-interactive rebase sequence to transfer
commits from START to ~HEAD~ onto NEWBASE. START has to be selected
@@ -5590,127 +5591,127 @@ Explicitly enabling ~--interactive~ won't have an
effect on the
following commands as they always use that argument anyway, even if it
is not enabled in the transient.
-- Key: r i, magit-rebase-interactive
+- Key: r i (magit-rebase-interactive) ::
This command starts an interactive rebase sequence.
-- Key: r f, magit-rebase-autosquash
+- Key: r f (magit-rebase-autosquash) ::
This command combines squash and fixup commits with their intended
targets.
-- Key: r m, magit-rebase-edit-commit
+- Key: r m (magit-rebase-edit-commit) ::
This command starts an interactive rebase sequence that lets the
user edit a single older commit.
-- Key: r w, magit-rebase-reword-commit
+- Key: r w (magit-rebase-reword-commit) ::
This command starts an interactive rebase sequence that lets the
user reword a single older commit.
-- Key: r k, magit-rebase-remove-commit
+- Key: r k (magit-rebase-remove-commit) ::
This command removes a single older commit using rebase.
When a rebase is in progress, then the transient instead features
the following suffix commands.
-- Key: r r, magit-rebase-continue
+- Key: r r (magit-rebase-continue) ::
This command restart the current rebasing operation.
In some cases this pops up a commit message buffer for you do edit.
With a prefix argument the old message is reused as-is.
-- Key: r s, magit-rebase-skip
+- Key: r s (magit-rebase-skip) ::
This command skips the current commit and restarts the current
rebase operation.
-- Key: r e, magit-rebase-edit
+- Key: r e (magit-rebase-edit) ::
This command lets the user edit the todo list of the current rebase
operation.
-- Key: r a, magit-rebase-abort
+- Key: r a (magit-rebase-abort) ::
This command aborts the current rebase operation, restoring the
original branch.
*** Editing Rebase Sequences
-- Key: C-c C-c, with-editor-finish
+- Key: C-c C-c (with-editor-finish) ::
Finish the current editing session by returning with exit code 0.
Git then uses the rebase instructions it finds in the file.
-- Key: C-c C-k, with-editor-cancel
+- Key: C-c C-k (with-editor-cancel) ::
Cancel the current editing session by returning with exit code 1.
Git then forgoes starting the rebase sequence.
-- Key: RET, git-rebase-show-commit
+- Key: RET (git-rebase-show-commit) ::
Show the commit on the current line in another buffer and select
that buffer.
-- Key: SPC, git-rebase-show-or-scroll-up
+- Key: SPC (git-rebase-show-or-scroll-up) ::
Show the commit on the current line in another buffer without
selecting that buffer. If the revision buffer is already visible in
another window of the current frame, then instead scroll that window
up.
-- Key: DEL, git-rebase-show-or-scroll-down
+- Key: DEL (git-rebase-show-or-scroll-down) ::
Show the commit on the current line in another buffer without
selecting that buffer. If the revision buffer is already visible in
another window of the current frame, then instead scroll that window
down.
-- Key: p, git-rebase-backward-line
+- Key: p (git-rebase-backward-line) ::
Move to previous line.
-- Key: n, forward-line
+- Key: n (forward-line) ::
Move to next line.
-- Key: M-p, git-rebase-move-line-up
+- Key: M-p (git-rebase-move-line-up) ::
Move the current commit (or command) up.
-- Key: M-n, git-rebase-move-line-down
+- Key: M-n (git-rebase-move-line-down) ::
Move the current commit (or command) down.
-- Key: r, git-rebase-reword
+- Key: r (git-rebase-reword) ::
Edit message of commit on current line.
-- Key: e, git-rebase-edit
+- Key: e (git-rebase-edit) ::
Stop at the commit on the current line.
-- Key: s, git-rebase-squash
+- Key: s (git-rebase-squash) ::
Meld commit on current line into previous commit, and edit message.
-- Key: f, git-rebase-fixup
+- Key: f (git-rebase-fixup) ::
Meld commit on current line into previous commit, discarding the
current commit's message.
-- Key: k, git-rebase-kill-line
+- Key: k (git-rebase-kill-line) ::
Kill the current action line.
-- Key: c, git-rebase-pick
+- Key: c (git-rebase-pick) ::
Use commit on current line.
-- Key: x, git-rebase-exec
+- Key: x (git-rebase-exec) ::
Insert a shell command to be run after the proceeding commit.
@@ -5719,29 +5720,29 @@ the following suffix commands.
there already is one on the current line. With empty input remove
the command on the current line, if any.
-- Key: b, git-rebase-break
+- Key: b (git-rebase-break) ::
Insert a break action before the current line, instructing Git to
return control to the user.
-- Key: y, git-rebase-insert
+- Key: y (git-rebase-insert) ::
Read an arbitrary commit and insert it below current line.
-- Key: C-x u, git-rebase-undo
+- Key: C-x u (git-rebase-undo) ::
Undo some previous changes. Like ~undo~ but works in read-only
buffers.
-- User Option: git-rebase-auto-advance
+- User Option: git-rebase-auto-advance ::
Whether to move to next line after changing a line.
-- User Option: git-rebase-show-instructions
+- User Option: git-rebase-show-instructions ::
Whether to show usage instructions inside the rebase buffer.
-- User Option: git-rebase-confirm-cancel
+- User Option: git-rebase-confirm-cancel ::
Whether confirmation is required to cancel.
@@ -5749,24 +5750,24 @@ When a rebase is performed with the ~--rebase-merges~
option, the
sequence will include a few other types of actions and the following
commands become relevant.
-- Key: l, git-rebase-label
+- Key: l (git-rebase-label) ::
This commands inserts a label action or edits the one at point.
-- Key: t, git-rebase-reset
+- Key: t (git-rebase-reset) ::
This command inserts a reset action or edits the one at point. The
prompt will offer the labels that are currently present in the
buffer.
-- Key: MM, git-rebase-merge
+- Key: MM (git-rebase-merge) ::
The command inserts a merge action or edits the one at point. The
prompt will offer the labels that are currently present in the
buffer. Specifying a message to reuse via ~-c~ or ~-C~ is not
supported; an editor will always be invoked for the merge.
-- Key: Mt, git-rebase-merge-toggle-editmsg
+- Key: Mt (git-rebase-merge-toggle-editmsg) ::
This command toggles between the ~-C~ and ~-c~ options of the merge
action at point. These options both specify a commit whose message
@@ -5947,7 +5948,7 @@ answer the question "Do these commits make the same
change?".
Also see [[man:git-cherry-pick]]
-- Key: A, magit-cherry-pick
+- Key: A (magit-cherry-pick) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
@@ -5956,14 +5957,14 @@ Also see [[man:git-cherry-pick]]
When no cherry-pick or revert is in progress, then the transient
features the following suffix commands.
-- Key: A A, magit-cherry-copy
+- Key: A A (magit-cherry-copy) ::
This command copies COMMITS from another branch onto the current
branch. If the region selects multiple commits, then those are
copied, without prompting. Otherwise the user is prompted for a
commit or range, defaulting to the commit at point.
-- Key: A a, magit-cherry-apply
+- Key: A a (magit-cherry-apply) ::
This command applies the changes in COMMITS from another branch onto
the current branch. If the region selects multiple commits, then
@@ -5981,7 +5982,7 @@ conflicts. If that happens, then these commands abort
and you not
only have to resolve the conflicts but also finish the process the
same way you would have to if these commands didn't exist at all.
-- Key: A h, magit-cherry-harvest
+- Key: A h (magit-cherry-harvest) ::
This command moves the selected COMMITS that must be located on
another BRANCH onto the current branch instead, removing them from
@@ -5993,7 +5994,7 @@ same way you would have to if these commands didn't exist
at all.
command stops and you have to resolve the conflicts and then finish
the process manually.
-- Key: A d, magit-cherry-donate
+- Key: A d (magit-cherry-donate) ::
This command moves the selected COMMITS from the current branch onto
another existing BRANCH, removing them from the former. When this
@@ -6005,7 +6006,7 @@ same way you would have to if these commands didn't exist
at all.
command stops and you have to resolve the conflicts and then finish
the process manually.
-- Key: A n, magit-cherry-spinout
+- Key: A n (magit-cherry-spinout) ::
This command moves the selected COMMITS from the current branch onto
a new branch BRANCH, removing them from the former. When this
@@ -6016,7 +6017,7 @@ same way you would have to if these commands didn't exist
at all.
command stops and you have to resolve the conflicts and then finish
the process manually.
-- Key: A s, magit-cherry-spinoff
+- Key: A s (magit-cherry-spinoff) ::
This command moves the selected COMMITS from the current branch onto
a new branch BRANCH, removing them from the former. When this
@@ -6030,22 +6031,22 @@ same way you would have to if these commands didn't
exist at all.
When a cherry-pick or revert is in progress, then the transient
instead features the following suffix commands.
-- Key: A A, magit-sequence-continue
+- Key: A A (magit-sequence-continue) ::
Resume the current cherry-pick or revert sequence.
-- Key: A s, magit-sequence-skip
+- Key: A s (magit-sequence-skip) ::
Skip the stopped at commit during a cherry-pick or revert sequence.
-- Key: A a, magit-sequence-abort
+- Key: A a (magit-sequence-abort) ::
Abort the current cherry-pick or revert sequence. This discards all
changes made since the sequence started.
*** Reverting
-- Key: V, magit-revert
+- Key: V (magit-revert) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
@@ -6054,13 +6055,13 @@ instead features the following suffix commands.
When no cherry-pick or revert is in progress, then the transient
features the following suffix commands.
-- Key: V V, magit-revert-and-commit
+- Key: V V (magit-revert-and-commit) ::
Revert a commit by creating a new commit. Prompt for a commit,
defaulting to the commit at point. If the region selects multiple
commits, then revert all of them, without prompting.
-- Key: V v, magit-revert-no-commit
+- Key: V v (magit-revert-no-commit) ::
Revert a commit by applying it in reverse to the working tree.
Prompt for a commit, defaulting to the commit at point. If the
@@ -6070,15 +6071,15 @@ features the following suffix commands.
When a cherry-pick or revert is in progress, then the transient
instead features the following suffix commands.
-- Key: V A, magit-sequence-continue
+- Key: V A (magit-sequence-continue) ::
Resume the current cherry-pick or revert sequence.
-- Key: V s, magit-sequence-skip
+- Key: V s (magit-sequence-skip) ::
Skip the stopped at commit during a cherry-pick or revert sequence.
-- Key: V a, magit-sequence-abort
+- Key: V a (magit-sequence-abort) ::
Abort the current cherry-pick or revert sequence. This discards all
changes made since the sequence started.
@@ -6087,48 +6088,48 @@ instead features the following suffix commands.
Also see [[man:git-reset]]
-- Key: x, magit-reset-quickly
+- Key: x (magit-reset-quickly) ::
Reset the ~HEAD~ and index to some commit read from the user and
defaulting to the commit at point, and possibly also reset the
working tree. With a prefix argument reset the working tree
otherwise don't.
-- Key: X m, magit-reset-mixed
+- Key: X m (magit-reset-mixed) ::
Reset the ~HEAD~ and index to some commit read from the user and
defaulting to the commit at point. The working tree is kept as-is.
-- Key: X s, magit-reset-soft
+- Key: X s (magit-reset-soft) ::
Reset the ~HEAD~ to some commit read from the user and defaulting
to the commit at point. The index and the working tree are kept
as-is.
-- Key: X h, magit-reset-hard
+- Key: X h (magit-reset-hard) ::
Reset the ~HEAD~, index, and working tree to some commit read from the
user and defaulting to the commit at point.
-- Key: X k, magit-reset-keep
+- Key: X k (magit-reset-keep) ::
Reset the ~HEAD~, index, and working tree to some commit read from the
user and defaulting to the commit at point. Uncommitted changes are
kept as-is.
-- Key: X i, magit-reset-index
+- Key: X i (magit-reset-index) ::
Reset the index to some commit read from the user and defaulting to
the commit at point. Keep the ~HEAD~ and working tree as-is, so if
the commit refers to the ~HEAD~, then this effectively unstages all
changes.
-- Key: X w, magit-reset-worktree
+- Key: X w (magit-reset-worktree) ::
Reset the working tree to some commit read from the user and
defaulting to the commit at point. Keep the ~HEAD~ and index as-is.
-- Key: X f, magit-file-checkout
+- Key: X f (magit-file-checkout) ::
Update file in the working tree and index to the contents from a
revision. Both the revision and file are read from the user.
@@ -6137,103 +6138,103 @@ Also see [[man:git-reset]]
Also see [[man:git-stash]]
-- Key: z, magit-stash
+- Key: z (magit-stash) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
-- Key: z z, magit-stash-both
+- Key: z z (magit-stash-both) ::
Create a stash of the index and working tree. Untracked files are
included according to infix arguments. One prefix argument is
equivalent to ~--include-untracked~ while two prefix arguments are
equivalent to ~--all~.
-- Key: z i, magit-stash-index
+- Key: z i (magit-stash-index) ::
Create a stash of the index only. Unstaged and untracked changes
are not stashed.
-- Key: z w, magit-stash-worktree
+- Key: z w (magit-stash-worktree) ::
Create a stash of unstaged changes in the working tree. Untracked
files are included according to infix arguments. One prefix
argument is equivalent to ~--include-untracked~ while two prefix
arguments are equivalent to ~--all~.
-- Key: z x, magit-stash-keep-index
+- Key: z x (magit-stash-keep-index) ::
Create a stash of the index and working tree, keeping index intact.
Untracked files are included according to infix arguments. One
prefix argument is equivalent to ~--include-untracked~ while two
prefix arguments are equivalent to ~--all~.
-- Key: z Z, magit-snapshot-both
+- Key: z Z (magit-snapshot-both) ::
Create a snapshot of the index and working tree. Untracked files
are included according to infix arguments. One prefix argument is
equivalent to ~--include-untracked~ while two prefix arguments are
equivalent to ~--all~.
-- Key: z I, magit-snapshot-index
+- Key: z I (magit-snapshot-index) ::
Create a snapshot of the index only. Unstaged and untracked changes
are not stashed.
-- Key: z W, magit-snapshot-worktree
+- Key: z W (magit-snapshot-worktree) ::
Create a snapshot of unstaged changes in the working tree.
Untracked files are included according to infix arguments. One
prefix argument is equivalent to ~--include-untracked~ while two
prefix arguments are equivalent to ~--all~-.
-- Key: z a, magit-stash-apply
+- Key: z a (magit-stash-apply) ::
Apply a stash to the working tree. Try to preserve the stash index.
If that fails because there are staged changes, apply without
preserving the stash index.
-- Key: z p, magit-stash-pop
+- Key: z p (magit-stash-pop) ::
Apply a stash to the working tree and remove it from stash list.
Try to preserve the stash index. If that fails because there are
staged changes, apply without preserving the stash index and forgo
removing the stash.
-- Key: z k, magit-stash-drop
+- Key: z k (magit-stash-drop) ::
Remove a stash from the stash list. When the region is active, offer
to drop all contained stashes.
-- Key: z v, magit-stash-show
+- Key: z v (magit-stash-show) ::
Show all diffs of a stash in a buffer.
-- Key: z b, magit-stash-branch
+- Key: z b (magit-stash-branch) ::
Create and checkout a new BRANCH from STASH. The branch starts at
the commit that was current when the stash was created.
-- Key: z B, magit-stash-branch-here
+- Key: z B (magit-stash-branch-here) ::
Create and checkout a new BRANCH using ~magit-branch~ with the current
branch or ~HEAD~ as the starting-point. Then apply STASH, dropping it
if it applies cleanly.
-- Key: z f, magit-stash-format-patch
+- Key: z f (magit-stash-format-patch) ::
Create a patch from STASH.
-- Key: k, magit-stash-clear
+- Key: k (magit-stash-clear) ::
Remove all stashes saved in REF's reflog by deleting REF.
-- Key: z l, magit-stash-list
+- Key: z l (magit-stash-list) ::
List all stashes in a buffer.
-- User Option: magit-stashes-margin
+- User Option: magit-stashes-margin ::
This option specifies whether the margin is initially shown in
stashes buffers and how it is formatted.
@@ -6265,7 +6266,7 @@ Those features are available from separate transient
commands.
Also see [[man:git-remote]]
-- Key: M, magit-remote
+- Key: M (magit-remote) ::
This transient prefix command binds the following suffix commands
and displays them in a temporary buffer until a suffix is invoked.
@@ -6273,7 +6274,7 @@ Also see [[man:git-remote]]
By default it also binds and displays the values of some
remote-related Git variables and allows changing their values.
-- User Option: magit-remote-direct-configure
+- User Option: magit-remote-direct-configure ::
This option controls whether remote-related Git variables are
accessible directly from the transient ~magit-remote~.
@@ -6284,7 +6285,7 @@ Also see [[man:git-remote]]
If ~nil~, then ~magit-remote-configure~ has to be used to do so.
-- Key: M C, magit-remote-configure
+- Key: M C (magit-remote-configure) ::
This transient prefix command binds commands that set the value of
remote-related variables and displays them in a temporary buffer
@@ -6301,31 +6302,31 @@ Also see [[man:git-remote]]
The variables are described in [[*Remote Git Variables]].
-- Key: M a, magit-remote-add
+- Key: M a (magit-remote-add) ::
This command add a remote and fetches it. The remote name and url
are read in the minibuffer.
-- Key: M r, magit-remote-rename
+- Key: M r (magit-remote-rename) ::
This command renames a remote. Both the old and the new names are
read in the minibuffer.
-- Key: M u, magit-remote-set-url
+- Key: M u (magit-remote-set-url) ::
This command changes the url of a remote. Both the remote and the
new url are read in the minibuffer.
-- Key: M k, magit-remote-remove
+- Key: M k (magit-remote-remove) ::
This command deletes a remote, read in the minibuffer.
-- Key: M p, magit-remote-prune
+- Key: M p (magit-remote-prune) ::
This command removes stale remote-tracking branches for a remote
read in the minibuffer.
-- Key: M P, magit-remote-prune-refspecs
+- Key: M P (magit-remote-prune-refspecs) ::
This command removes stale refspecs for a remote read in the
minibuffer.
@@ -6343,7 +6344,7 @@ The variables are described in [[*Remote Git Variables]].
created due to the now stale refspecs. Other stale branches are
not removed.
-- User Option: magit-remote-add-set-remote.pushDefault
+- User Option: magit-remote-add-set-remote.pushDefault ::
This option controls whether the user is asked whether they want to
set ~remote.pushDefault~ after adding a remote.
@@ -6361,28 +6362,28 @@ These variables can be set from the transient prefix
command
~magit-remote-configure~. By default they can also be set from
~magit-remote~. See [[*Remote Commands]].
-- Variable: remote.NAME.url
+- Variable: remote.NAME.url ::
This variable specifies the url of the remote named NAME. It can
have multiple values.
-- Variable: remote.NAME.fetch
+- Variable: remote.NAME.fetch ::
The refspec used when fetching from the remote named NAME. It can
have multiple values.
-- Variable: remote.NAME.pushurl
+- Variable: remote.NAME.pushurl ::
This variable specifies the url used for fetching from the remote
named NAME. If it is not specified, then ~remote.NAME.url~ is used
instead. It can have multiple values.
-- Variable: remote.NAME.push
+- Variable: remote.NAME.push ::
The refspec used when pushing to the remote named NAME. It can
have multiple values.
-- Variable: remote.NAME.tagOpts
+- Variable: remote.NAME.tagOpts ::
This variable specifies what tags are fetched by default. If the
value is ~--no-tags~ then no tags are fetched. If the value is
@@ -6394,13 +6395,13 @@ These variables can be set from the transient prefix
command
Also see [[man:git-fetch]] For information about the upstream and the
push-remote, see [[*The Two Remotes]].
-- Key: f, magit-fetch
+- Key: f (magit-fetch) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
-- Key: f p, magit-fetch-from-pushremote
+- Key: f p (magit-fetch-from-pushremote) ::
This command fetches from the current push-remote.
@@ -6408,7 +6409,7 @@ push-remote, see [[*The Two Remotes]].
configured or unusable, then let the user first configure the
push-remote.
-- Key: f u, magit-fetch-from-upstream
+- Key: f u (magit-fetch-from-upstream) ::
This command fetch from the upstream of the current branch.
@@ -6421,30 +6422,30 @@ push-remote, see [[*The Two Remotes]].
from the ~magit-fetch~ transient prefix and invoking it directly
results in an error.
-- Key: f e, magit-fetch-other
+- Key: f e (magit-fetch-other) ::
This command fetch from a repository read from the minibuffer.
-- Key: f o, magit-fetch-branch
+- Key: f o (magit-fetch-branch) ::
This command fetches a branch from a remote, both of which are read
from the minibuffer.
-- Key: f r, magit-fetch-refspec
+- Key: f r (magit-fetch-refspec) ::
This command fetches from a remote using an explicit refspec, both
of which are read from the minibuffer.
-- Key: f a, magit-fetch-all
+- Key: f a (magit-fetch-all) ::
This command fetches from all remotes.
-- Key: f m, magit-submodule-fetch
+- Key: f m (magit-submodule-fetch) ::
This command fetches all submodules. With a prefix argument it
fetches all remotes of all submodules.
-- User Option: magit-pull-or-fetch
+- User Option: magit-pull-or-fetch ::
By default fetch and pull commands are available from separate
transient prefix command. Setting this to ~t~ adds some (but not all)
@@ -6464,12 +6465,12 @@ push-remote, see [[*The Two Remotes]].
Also see [[man:git-pull]] For information about the upstream and the
push-remote, see [[*The Two Remotes]].
-- Key: F, magit-pull
+- Key: F (magit-pull) ::
This transient prefix command binds the following suffix commands
and displays them in a temporary buffer until a suffix is invoked.
-- Key: F p, magit-pull-from-pushremote
+- Key: F p (magit-pull-from-pushremote) ::
This command pulls from the push-remote of the current branch.
@@ -6477,7 +6478,7 @@ push-remote, see [[*The Two Remotes]].
configured or unusable, then let the user first configure the
push-remote.
-- Key: F u, magit-pull-from-upstream
+- Key: F u (magit-pull-from-upstream) ::
This command pulls from the upstream of the current branch.
@@ -6485,7 +6486,7 @@ push-remote, see [[*The Two Remotes]].
configured or unusable, then let the user first configure
the upstream.
-- Key: F e, magit-pull-branch
+- Key: F e (magit-pull-branch) ::
This command pulls from a branch read in the minibuffer.
@@ -6494,13 +6495,13 @@ push-remote, see [[*The Two Remotes]].
Also see [[man:git-push]] For information about the upstream and the
push-remote, see [[*The Two Remotes]].
-- Key: P, magit-push
+- Key: P (magit-push) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
-- Key: P p, magit-push-current-to-pushremote
+- Key: P p (magit-push-current-to-pushremote) ::
This command pushes the current branch to its push-remote.
@@ -6508,7 +6509,7 @@ push-remote, see [[*The Two Remotes]].
configured or unusable, then let the user first configure the
push-remote.
-- Key: P u, magit-push-current-to-upstream
+- Key: P u (magit-push-current-to-upstream) ::
This command pushes the current branch to its upstream branch.
@@ -6516,17 +6517,17 @@ push-remote, see [[*The Two Remotes]].
configured or unusable, then let the user first configure
the upstream.
-- Key: P e, magit-push-current
+- Key: P e (magit-push-current) ::
This command pushes the current branch to a branch read in the
minibuffer.
-- Key: P o, magit-push-other
+- Key: P o (magit-push-other) ::
This command pushes an arbitrary branch or commit somewhere. Both
the source and the target are read in the minibuffer.
-- Key: P r, magit-push-refspecs
+- Key: P r (magit-push-refspecs) ::
This command pushes one or multiple refspecs to a remote, both of
which are read in the minibuffer.
@@ -6535,7 +6536,7 @@ push-remote, see [[*The Two Remotes]].
only available for the part before the colon, or when no colon is
used.
-- Key: P m, magit-push-matching
+- Key: P m (magit-push-matching) ::
This command pushes all matching branches to another repository.
@@ -6543,7 +6544,7 @@ push-remote, see [[*The Two Remotes]].
a remote, offering the remote configured for the current branch as
default.
-- Key: P t, magit-push-tags
+- Key: P t (magit-push-tags) ::
This command pushes all tags to another repository.
@@ -6551,7 +6552,7 @@ push-remote, see [[*The Two Remotes]].
a remote, offering the remote configured for the current branch as
default.
-- Key: P T, magit-push-tag
+- Key: P T (magit-push-tag) ::
This command pushes a tag to another repository.
@@ -6569,7 +6570,7 @@ Two more push commands exist, which by default are not
available from
the push transient. See their doc-strings for instructions on how to
add them to the transient.
-- Command: magit-push-implicitly args
+- Command: magit-push-implicitly args ::
This command pushes somewhere without using an explicit refspec.
@@ -6589,7 +6590,7 @@ add them to the transient.
'(\"i\" magit-push-implicitly))"
#+END_SRC
-- Command: magit-push-to-remote remote args
+- Command: magit-push-to-remote remote args ::
This command pushes to the remote REMOTE without using an explicit
refspec. The remote is read in the minibuffer.
@@ -6603,13 +6604,13 @@ add them to the transient.
** Plain Patches
-- Key: W, magit-patch
+- Key: W (magit-patch) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
-- Key: W c, magit-patch-create
+- Key: W c (magit-patch-create) ::
This command creates patches for a set commits. If the region marks
several commits, then it creates patches for all of them. Otherwise
@@ -6618,14 +6619,14 @@ add them to the transient.
command is invoked as a suffix of itself, then it creates a patch
using the specified infix arguments.
-- Key: w a, magit-patch-apply
+- Key: w a (magit-patch-apply) ::
This command applies a patch. This is a transient prefix command,
which features several infix arguments and binds itself as a suffix
command. When this command is invoked as a suffix of itself, then
it applies a patch using the specified infix arguments.
-- Key: W s, magit-patch-save
+- Key: W s (magit-patch-save) ::
This command creates a patch from the current diff.
@@ -6639,24 +6640,24 @@ a ~magit-diff-mode~ or ~magit-revision-mode~ buffer.
Also see [[man:git-am]] and [[man:git-apply]]
-- Key: w, magit-am
+- Key: w (magit-am) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
-- Key: w w, magit-am-apply-patches
+- Key: w w (magit-am-apply-patches) ::
This command applies one or more patches. If the region marks
files, then those are applied as patches. Otherwise this command
reads a file-name in the minibuffer, defaulting to the file at
point.
-- Key: w m, magit-am-apply-maildir
+- Key: w m (magit-am-apply-maildir) ::
This command applies patches from a maildir.
-- Key: w a, magit-patch-apply
+- Key: w a (magit-patch-apply) ::
This command applies a plain patch. For a longer description see
[[*Plain Patches]]. This command is only available from the ~magit-am~
@@ -6665,16 +6666,16 @@ Also see [[man:git-am]] and [[man:git-apply]]
When an "am" operation is in progress, then the transient instead
features the following suffix commands.
-- Key: w w, magit-am-continue
+- Key: w w (magit-am-continue) ::
This command resumes the current patch applying sequence.
-- Key: w s, magit-am-skip
+- Key: w s (magit-am-skip) ::
This command skips the stopped at patch during a patch applying
sequence.
-- Key: w a, magit-am-abort
+- Key: w a (magit-am-abort) ::
This command aborts the current patch applying sequence. This
discards all changes made since the sequence started.
@@ -6684,18 +6685,18 @@ features the following suffix commands.
Also see [[man:git-tag]]
-- Key: t, magit-tag
+- Key: t (magit-tag) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
-- Key: t t, magit-tag-create
+- Key: t t (magit-tag-create) ::
This command creates a new tag with the given NAME at REV. With a
prefix argument it creates an annotated tag.
-- Key: t r, magit-tag-release
+- Key: t r (magit-tag-release) ::
This commands creates a release tag. It assumes that release tags
match ~magit-release-tag-regexp~.
@@ -6715,14 +6716,14 @@ Also see [[man:git-tag]]
TAG "v1.2.3" and a repository located at something like
"/path/to/foo-bar".
-- Key: t k, magit-tag-delete
+- Key: t k (magit-tag-delete) ::
This command deletes one or more tags. If the region marks multiple
tags (and nothing else), then it offers to delete those. Otherwise,
it prompts for a single tag to be deleted, defaulting to the tag at
point.
-- Key: t p, magit-tag-prune
+- Key: t p (magit-tag-prune) ::
This command offers to delete tags missing locally from REMOTE, and
vice versa.
@@ -6731,13 +6732,13 @@ Also see [[man:git-tag]]
Also see [[man:git-notes]]
-- Key: T, magit-notes
+- Key: T (magit-notes) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
-- Key: T T, magit-notes-edit
+- Key: T T (magit-notes-edit) ::
Edit the note attached to a commit, defaulting to the commit at
point.
@@ -6745,7 +6746,7 @@ Also see [[man:git-notes]]
By default use the value of Git variable ~core.notesRef~ or
"refs/notes/commits" if that is undefined.
-- Key: T r, magit-notes-remove
+- Key: T r (magit-notes-remove) ::
Remove the note attached to a commit, defaulting to the commit at
point.
@@ -6753,7 +6754,7 @@ Also see [[man:git-notes]]
By default use the value of Git variable ~core.notesRef~ or
"refs/notes/commits" if that is undefined.
-- Key: T p, magit-notes-prune
+- Key: T p (magit-notes-prune) ::
Remove notes about unreachable commits.
@@ -6761,7 +6762,7 @@ It is possible to merge one note ref into another. That
may result in
conflicts which have to resolved in the temporary worktree
".git/NOTES_MERGE_WORKTREE".
-- Key: T m, magit-notes-merge
+- Key: T m (magit-notes-merge) ::
Merge the notes of a ref read from the user into the current notes
ref. The current notes ref is the value of Git variable
@@ -6770,12 +6771,12 @@ conflicts which have to resolved in the temporary
worktree
When a notes merge is in progress then the transient features the
following suffix commands, instead of those listed above.
-- Key: T c, magit-notes-merge-commit
+- Key: T c (magit-notes-merge-commit) ::
Commit the current notes ref merge, after manually resolving
conflicts.
-- Key: T a, magit-notes-merge-abort
+- Key: T a (magit-notes-merge-abort) ::
Abort the current notes ref merge.
@@ -6783,12 +6784,12 @@ The following variables control what notes reference
~magit-notes-*~,
~git notes~ and ~git show~ act on and display. Both the local and global
values are displayed and can be modified.
-- Variable: core.notesRef
+- Variable: core.notesRef ::
This variable specifies the notes ref that is displayed by default
and which commands act on by default.
-- Variable: notes.displayRef
+- Variable: notes.displayRef ::
This variable specifies additional notes ref to be displayed in
addition to the ref specified by ~core.notesRef~. It can have
@@ -6807,14 +6808,14 @@ display information about submodules directly in the
status buffer of
the super-repository by adding ~magit-insert-modules~ to the hook
~magit-status-sections-hook~ as described in [[*Status Module Sections]].
-- Command: magit-list-submodules
+- Command: magit-list-submodules ::
This command displays a list of the current repository's submodules
in a separate buffer.
It can be invoked by pressing ~RET~ on the section titled "Modules".
-- User Option: magit-submodule-list-columns
+- User Option: magit-submodule-list-columns ::
This option controls what columns are displayed by the command
~magit-list-submodules~ and how they are displayed.
@@ -6830,7 +6831,7 @@ the super-repository by adding ~magit-insert-modules~ to
the hook
*** Submodule Transient
-- Key: o, magit-submodule
+- Key: o (magit-submodule) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
@@ -6844,44 +6845,44 @@ read a single module to act on. With a prefix argument
these commands
ignore the selection and the current module and instead act on all
suitable modules.
-- Key: o a, magit-submodule-add
+- Key: o a (magit-submodule-add) ::
This commands adds the repository at URL as a module. Optional PATH
is the path to the module relative to the root of the super-project.
If it is nil then the path is determined based on URL.
-- Key: o r, magit-submodule-register
+- Key: o r (magit-submodule-register) ::
This command registers the selected modules by copying their urls
from ".gitmodules" to "$GIT_DIR/config". These values can then be
edited before running ~magit-submodule-populate~. If you don't need
to edit any urls, then use the latter directly.
-- Key: o p, magit-submodule-populate
+- Key: o p (magit-submodule-populate) ::
This command creates the working directory or directories of the
selected modules, checking out the recorded commits.
-- Key: o u, magit-submodule-update
+- Key: o u (magit-submodule-update) ::
This command updates the selected modules checking out the recorded
commits.
-- Key: o s, magit-submodule-synchronize
+- Key: o s (magit-submodule-synchronize) ::
This command synchronizes the urls of the selected modules, copying
the values from ".gitmodules" to the ".git/config" of the
super-project as well those of the modules.
-- Key: o d, magit-submodule-unpopulate
+- Key: o d (magit-submodule-unpopulate) ::
This command removes the working directory of the selected modules.
-- Key: o l, magit-list-submodules
+- Key: o l (magit-list-submodules) ::
This command displays a list of the current repository's modules.
-- Key: o f, magit-fetch-modules
+- Key: o f (magit-fetch-modules) ::
This command fetches all modules.
@@ -6894,12 +6895,12 @@ suitable modules.
Also see [[man:git-subtree]]
-- Key: O, magit-subtree
+- Key: O (magit-subtree) ::
This transient prefix command binds the two sub-transients; one for
importing a subtree and one for exporting a subtree.
-- Key: O i, magit-subtree-import
+- Key: O i (magit-subtree-import) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
@@ -6911,23 +6912,23 @@ Also see [[man:git-subtree]]
prefix without prompting the user. If it is unset, then they read
the prefix in the minibuffer.
-- Key: O i a, magit-subtree-add
+- Key: O i a (magit-subtree-add) ::
This command adds COMMIT from REPOSITORY as a new subtree at PREFIX.
-- Key: O i c, magit-subtree-add-commit
+- Key: O i c (magit-subtree-add-commit) ::
This command add COMMIT as a new subtree at PREFIX.
-- Key: O i m, magit-subtree-merge
+- Key: O i m (magit-subtree-merge) ::
This command merges COMMIT into the PREFIX subtree.
-- Key: O i f, magit-subtree-pull
+- Key: O i f (magit-subtree-pull) ::
This command pulls COMMIT from REPOSITORY into the PREFIX subtree.
-- Key: O e, magit-subtree-export
+- Key: O e (magit-subtree-export) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
@@ -6939,12 +6940,12 @@ Also see [[man:git-subtree]]
prefix without prompting the user. If it is unset, then they read
the prefix in the minibuffer.
-- Key: O e p, magit-subtree-push
+- Key: O e p (magit-subtree-push) ::
This command extract the history of the subtree PREFIX and pushes it
to REF on REPOSITORY.
-- Key: O e s, magit-subtree-split
+- Key: O e s (magit-subtree-split) ::
This command extracts the history of the subtree PREFIX.
@@ -6952,29 +6953,29 @@ Also see [[man:git-subtree]]
Also see [[man:git-worktree]]
-- Key: Z, magit-worktree
+- Key: Z (magit-worktree) ::
This transient prefix command binds the following suffix commands
and displays them in a temporary buffer until a suffix is invoked.
-- Key: Z b, magit-worktree-checkout
+- Key: Z b (magit-worktree-checkout) ::
Checkout BRANCH in a new worktree at PATH.
-- Key: Z c, magit-worktree-branch
+- Key: Z c (magit-worktree-branch) ::
Create a new BRANCH and check it out in a new worktree at PATH.
-- Key: Z m, magit-worktree-move
+- Key: Z m (magit-worktree-move) ::
Move an existing worktree to a new PATH.
-- Key: Z k, magit-worktree-delete
+- Key: Z k (magit-worktree-delete) ::
Delete a worktree, defaulting to the worktree at point.
The primary worktree cannot be deleted.
-- Key: Z g, magit-worktree-status
+- Key: Z g (magit-worktree-status) ::
Show the status for the worktree at point.
@@ -6986,7 +6987,7 @@ Also see [[man:git-worktree]]
Also see [[man:git-bundle]]
-- Command: magit-bundle
+- Command: magit-bundle ::
This transient prefix command binds several suffix commands for
running ~git bundle~ subcommands and displays them in a temporary
@@ -6994,10 +6995,10 @@ Also see [[man:git-bundle]]
** Common Commands
-- Command: magit-switch-to-repository-buffer
-- Command: magit-switch-to-repository-buffer-other-window
-- Command: magit-switch-to-repository-buffer-other-frame
-- Command: magit-display-repository-buffer
+- Command: magit-switch-to-repository-buffer ::
++ Command: magit-switch-to-repository-buffer-other-window ::
++ Command: magit-switch-to-repository-buffer-other-frame ::
++ Command: magit-display-repository-buffer ::
These commands read any existing Magit buffer that belongs to the
current repository from the user and then switch to the selected
@@ -7010,7 +7011,7 @@ These are some of the commands that can be used in all
buffers whose
major-modes derive from ~magit-mode~. There are other common commands
beside the ones below, but these didn't fit well anywhere else.
-- Key: C-w, magit-copy-section-value
+- Key: C-w (magit-copy-section-value) ::
This command saves the value of the current section to the
~kill-ring~, and, provided that the current section is a commit,
@@ -7028,7 +7029,7 @@ beside the ones below, but these didn't fit well anywhere
else.
only either the added or removed lines, depending on the sign of
the prefix argument.
-- Key: M-w, magit-copy-buffer-revision
+- Key: M-w (magit-copy-buffer-revision) ::
This command saves the revision being displayed in the current buffer
to the ~kill-ring~ and also pushes it to the ~magit-revision-stack~. It
@@ -7072,7 +7073,7 @@ then ~HEAD~ is used in place of ~<branchref>~.
Checking out another branch (or detaching ~HEAD~) causes the use of
different wip refs for subsequent changes.
-- User Option: magit-wip-mode
+- User Option: magit-wip-mode ::
When this mode is enabled, then uncommitted changes are committed
to dedicated work-in-progress refs whenever appropriate (i.e. when
@@ -7090,7 +7091,7 @@ To view the log for a branch and its wip refs use the
commands
~magit-wip-log~ and ~magit-wip-log-current~. You should use ~--graph~ when
using these commands.
-- Command: magit-wip-log
+- Command: magit-wip-log ::
This command shows the log for a branch and its wip refs.
With a negative prefix argument only the worktree wip ref is shown.
@@ -7099,7 +7100,7 @@ using these commands.
"branches" of each wip ref are shown. This is only relevant if the
value of ~magit-wip-merge-branch~ is ~nil~.
-- Command: magit-wip-log-current
+- Command: magit-wip-log-current ::
This command shows the log for the current branch and its wip refs.
With a negative prefix argument only the worktree wip ref is shown.
@@ -7108,7 +7109,7 @@ using these commands.
"branches" of each wip ref are shown. This is only relevant if the
value of ~magit-wip-merge-branch~ is ~nil~.
-- Key: X w, magit-reset-worktree
+- Key: X w (magit-reset-worktree) ::
This command resets the working tree to some commit read from the
user and defaulting to the commit at point, while keeping the ~HEAD~
@@ -7130,7 +7131,7 @@ When you are unsure whether Magit did commit a change to
the wip refs,
then you can explicitly request that all changes to all tracked files
are being committed.
-- Key: M-x magit-wip-commit, magit-wip-commit
+- Key: M-x magit-wip-commit ::
This command commits all changes to all tracked files to the index
and working tree work-in-progress refs. Like the modes described above,
@@ -7138,20 +7139,20 @@ are being committed.
files for changes. Use this command when you suspect that the modes
might have overlooked a change made outside Emacs/Magit.
-- User Option: magit-wip-namespace
+- User Option: magit-wip-namespace ::
The namespace used for work-in-progress refs. It has to end with
a slash. The wip refs are named ~<namespace>index/<branchref>~ and
~<namespace>wtree/<branchref>~. When snapshots are created while
the ~HEAD~ is detached then ~HEAD~ is used in place of ~<branchref>~.
-- User Option: magit-wip-mode-lighter
+- User Option: magit-wip-mode-lighter ::
Mode-line lighter for ~magit-wip--mode~.
*** Wip Graph
-- User Option: magit-wip-merge-branch
+- User Option: magit-wip-merge-branch ::
This option controls whether the current branch is merged into the
wip refs after a new commit was created on the branch.
@@ -7221,13 +7222,13 @@ Setting the following variables directly does not take
effect; either
use the Custom interface to do so or call the respective mode
functions.
-- User Option: magit-wip-after-save-mode
+- User Option: magit-wip-after-save-mode ::
When this mode is enabled, then saving a buffer that visits a file
tracked in a Git repository causes its current state to be committed
to the working tree wip ref for the current branch.
-- User Option: magit-wip-after-apply-mode
+- User Option: magit-wip-after-apply-mode ::
When this mode is enabled, then applying (i.e. staging, unstaging,
discarding, reversing, and regularly applying) a change to a file
@@ -7240,12 +7241,12 @@ each and every change from accidental loss. In
practice nobody does
that. Two additional modes exists that do commit to the wip refs
before making changes that could cause the loss of earlier changes.
-- User Option: magit-wip-before-change-mode
+- User Option: magit-wip-before-change-mode ::
When this mode is enabled, then certain commands commit the existing
changes to the files they are about to make changes to.
-- User Option: magit-wip-initial-backup-mode
+- User Option: magit-wip-initial-backup-mode ::
When this mode is enabled, then the current version of a file is
committed to the worktree wip ref before the buffer visiting that
@@ -7262,19 +7263,19 @@ before making changes that could cause the loss of
earlier changes.
used along-side that function, which is recommended because it only
backs up files that are tracked in a Git repository.
-- User Option: magit-wip-after-save-local-mode-lighter
+- User Option: magit-wip-after-save-local-mode-lighter ::
Mode-line lighter for ~magit-wip-after-save-local-mode~.
-- User Option: magit-wip-after-apply-mode-lighter
+- User Option: magit-wip-after-apply-mode-lighter ::
Mode-line lighter for ~magit-wip-after-apply-mode~.
-- User Option: magit-wip-before-change-mode-lighter
+- User Option: magit-wip-before-change-mode-lighter ::
Mode-line lighter for ~magit-wip-before-change-mode~.
-- User Option: magit-wip-initial-backup-mode-lighter
+- User Option: magit-wip-initial-backup-mode-lighter ::
Mode-line lighter for ~magit-wip-initial-backup-mode~.
@@ -7297,7 +7298,7 @@ If you want a better binding, you have to add it yourself:
The key bindings shown below assume that you have not improved the
binding for ~magit-file-dispatch~.
-- Key: C-c M-g, magit-file-dispatch
+- Key: C-c M-g (magit-file-dispatch) ::
This transient prefix command binds the following suffix commands
and displays them in a temporary buffer until a suffix is invoked.
@@ -7305,22 +7306,22 @@ binding for ~magit-file-dispatch~.
When invoked in a buffer that does not visit a file, then it falls
back to regular ~magit-dispatch~.
-- Key: C-c M-g s, magit-stage-file
+- Key: C-c M-g s (magit-stage-file) ::
Stage all changes to the file being visited in the current buffer.
-- Key: C-c M-g u, magit-unstage-file
+- Key: C-c M-g u (magit-unstage-file) ::
Unstage all changes to the file being visited in the current buffer.
-- Key: C-c M-g c, magit-commit
+- Key: C-c M-g c (magit-commit) ::
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked. See [[*Initiating a
Commit]].
-- Key: C-c M-g D, magit-diff
+- Key: C-c M-g D (magit-diff) ::
This transient prefix command binds several diff suffix commands and
infix arguments and displays them in a temporary buffer until a
@@ -7331,17 +7332,17 @@ binding for ~magit-file-dispatch~.
initial value of the option (~--~) that limits the diff to certain
file(s) is set to the visited file.
-- Key: C-c M-g d, magit-diff-buffer-file
+- Key: C-c M-g d (magit-diff-buffer-file) ::
This command shows the diff for the file of blob that the current
buffer visits.
-- User Option: magit-diff-buffer-file-locked
+- User Option: magit-diff-buffer-file-locked ::
This option controls whether ~magit-diff-buffer-file~ uses a dedicated
buffer. See [[*Modes and Buffers]].
-- Key: C-c M-g L, magit-log
+- Key: C-c M-g L (magit-log) ::
This transient prefix command binds several log suffix commands and
infix arguments and displays them in a temporary buffer until a
@@ -7352,23 +7353,23 @@ binding for ~magit-file-dispatch~.
initial value of the option (~--~) that limits the log to certain
file(s) is set to the visited file.
-- Key: C-c M-g l, magit-log-buffer-file
+- Key: C-c M-g l (magit-log-buffer-file) ::
This command shows the log for the file of blob that the current
buffer visits. Renames are followed when a prefix argument is used
or when ~--follow~ is an active log argument. When the region is
active, the log is restricted to the selected line range.
-- Key: C-c M-g t, magit-log-trace-definition
+- Key: C-c M-g t (magit-log-trace-definition) ::
This command shows the log for the definition at point.
-- User Option: magit-log-buffer-file-locked
+- User Option: magit-log-buffer-file-locked ::
This option controls whether ~magit-log-buffer-file~ uses a dedicated
buffer. See [[*Modes and Buffers]].
-- Key: C-c M-g B, magit-blame
+- Key: C-c M-g B (magit-blame) ::
This transient prefix command binds all blaming suffix commands
along with the appropriate infix arguments and displays them in a
@@ -7381,7 +7382,7 @@ In addition to the ~magit-blame~ sub-transient, the
dispatch transient
also binds several blaming suffix commands directly. See [[*Blaming]] for
information about those commands and bindings.
-- Key: C-c M-g e, magit-edit-line-commit
+- Key: C-c M-g e (magit-edit-line-commit) ::
This command makes the commit editable that added the current line.
@@ -7391,26 +7392,26 @@ information about those commands and bindings.
~HEAD~, or by checking out the commit (or a branch that points at it)
otherwise.
-- Key: C-c M-g p, magit-blob-previous
+- Key: C-c M-g p (magit-blob-previous) ::
Visit the previous blob which modified the current file.
There are a few additional commands that operate on a single file but
are not enabled in the file transient command by default:
-- Command: magit-file-rename
+- Command: magit-file-rename ::
This command renames a file read from the user.
-- Command: magit-file-delete
+- Command: magit-file-delete ::
This command deletes a file read from the user.
-- Command: magit-file-untrack
+- Command: magit-file-untrack ::
This command untracks a file read from the user.
-- Command: magit-file-checkout
+- Command: magit-file-checkout ::
This command updates a file in the working tree and index to the
contents from a revision. Both the revision and file are read
@@ -7428,15 +7429,15 @@ of the commands mentioned below, which also take care
of turning on
this minor mode. Currently this mode only establishes a few key
bindings, but this might be extended.
-- Key: p, magit-blob-previous
+- Key: p (magit-blob-previous) ::
Visit the previous blob which modified the current file.
-- Key: n, magit-blob-next
+- Key: n (magit-blob-next) ::
Visit the next blob which modified the current file.
-- Key: q, magit-kill-this-buffer
+- Key: q (magit-kill-this-buffer) ::
Kill the current buffer.
@@ -7501,7 +7502,8 @@ repository:
. ((eval . (magit-disable-section-inserter 'magit-insert-tags-header)))))
#+END_SRC
-- Function: magit-disable-section-inserter fn
+# new list
+- Function: magit-disable-section-inserter fn ::
This function disables the section inserter FN in the current
repository. It is only intended for use in ~.dir-locals.el~ and
@@ -7784,7 +7786,7 @@ for more information.
*** Default Bindings
-- User Option: magit-define-global-key-bindings
+- User Option: magit-define-global-key-bindings ::
This option controls whether some Magit commands are automatically
bound in the global keymap even before Magit is used for the first
@@ -7878,46 +7880,46 @@ These functions run Git in order to get a value, an exit
status, or output. Of course you could also use them to run Git
commands that have side-effects, but that should be avoided.
-- Function: magit-git-exit-code &rest args
+- Function: magit-git-exit-code &rest args ::
Executes git with ARGS and returns its exit code.
-- Function: magit-git-success &rest args
+- Function: magit-git-success &rest args ::
Executes git with ARGS and returns ~t~ if the exit code is ~0~, ~nil~
otherwise.
-- Function: magit-git-failure &rest args
+- Function: magit-git-failure &rest args ::
Executes git with ARGS and returns ~t~ if the exit code is ~1~, ~nil~
otherwise.
-- Function: magit-git-true &rest args
+- Function: magit-git-true &rest args ::
Executes git with ARGS and returns ~t~ if the first line printed by
git is the string "true", ~nil~ otherwise.
-- Function: magit-git-false &rest args
+- Function: magit-git-false &rest args ::
Executes git with ARGS and returns ~t~ if the first line printed by
git is the string "false", ~nil~ otherwise.
-- Function: magit-git-insert &rest args
+- Function: magit-git-insert &rest args ::
Executes git with ARGS and inserts its output at point.
-- Function: magit-git-string &rest args
+- Function: magit-git-string &rest args ::
Executes git with ARGS and returns the first line of its output. If
there is no output or if it begins with a newline character, then
this returns ~nil~.
-- Function: magit-git-lines &rest args
+- Function: magit-git-lines &rest args ::
Executes git with ARGS and returns its output as a list of lines.
Empty lines anywhere in the output are omitted.
-- Function: magit-git-items &rest args
+- Function: magit-git-items &rest args ::
Executes git with ARGS and returns its null-separated output as a
list. Empty items anywhere in the output are omitted.
@@ -7927,7 +7929,7 @@ commands that have side-effects, but that should be
avoided.
add a section containing git's standard error in the current
repository's process buffer.
-- Function: magit-process-git destination &rest args
+- Function: magit-process-git destination &rest args ::
Calls Git synchronously in a separate process, returning its exit
code. DESTINATION specifies how to handle the output, like for
@@ -7935,7 +7937,7 @@ commands that have side-effects, but that should be
avoided.
Cygwin's "noglob" option during the call and ensures unix eol
conversion.
-- Function: magit-process-file process &optional infile buffer display &rest
args
+- Function: magit-process-file process &optional infile buffer display &rest
args ::
Processes files synchronously in a separate process. Identical to
~process-file~ but temporarily enables Cygwin's "noglob" option during
@@ -7946,7 +7948,7 @@ is usually due to a bug, i.e. using an argument which is
not
actually supported. Such errors are usually not reported, but when
they occur we need to be able to debug them.
-- User Option: magit-git-debug
+- User Option: magit-git-debug ::
Whether to report errors that occur when using ~magit-git-insert~,
~magit-git-string~, ~magit-git-lines~, or ~magit-git-items~. This does
@@ -7954,7 +7956,7 @@ they occur we need to be able to debug them.
area, and git's standard error is insert into a new section in the
current repository's process buffer.
-- Function: magit-git-str &rest args
+- Function: magit-git-str &rest args ::
This is a variant of ~magit-git-string~ that ignores the option
~magit-git-debug~. It is mainly intended to be used while handling
@@ -7987,19 +7989,19 @@ wait for git to complete before letting the user do
something else.
For example after staging a change it is useful to wait until after
the refresh because that also automatically moves to the next change.
-- Function: magit-call-git &rest args
+- Function: magit-call-git &rest args ::
Calls git synchronously with ARGS.
-- Function: magit-call-process program &rest args
+- Function: magit-call-process program &rest args ::
Calls PROGRAM synchronously with ARGS.
-- Function: magit-run-git &rest args
+- Function: magit-run-git &rest args ::
Calls git synchronously with ARGS and then refreshes.
-- Function: magit-run-git-with-input &rest args
+- Function: magit-run-git-with-input &rest args ::
Calls git synchronously with ARGS and sends it the content of the
current buffer on standard input.
@@ -8009,12 +8011,12 @@ the refresh because that also automatically moves to
the next change.
then it waits for the process to return, so the function itself is
synchronous.
-- Function: magit-git &rest args
+- Function: magit-git &rest args ::
Calls git synchronously with ARGS for side-effects only. This
function does not refresh the buffer.
-- Function: magit-git-wash washer &rest args
+- Function: magit-git-wash washer &rest args ::
Execute Git with ARGS, inserting washed output at point. Actually
first insert the raw output at point. If there is no output call
@@ -8024,7 +8026,7 @@ the refresh because that also automatically moves to the
next change.
And now for the asynchronous variants.
-- Function: magit-run-git-async &rest args
+- Function: magit-run-git-async &rest args ::
Start Git, prepare for refresh, and return the process object.
ARGS is flattened and then used as arguments to Git.
@@ -8037,7 +8039,7 @@ And now for the asynchronous variants.
Unmodified buffers visiting files that are tracked in the current
repository are reverted if ~magit-revert-buffers~ is non-nil.
-- Function: magit-run-git-with-editor &rest args
+- Function: magit-run-git-with-editor &rest args ::
Export GIT_EDITOR and start Git. Also prepare for refresh and
return the process object. ARGS is flattened and then used as
@@ -8049,7 +8051,7 @@ And now for the asynchronous variants.
current when this function was called (if it is a Magit buffer and
still alive), as well as the respective Magit status buffer.
-- Function: magit-start-git input &rest args
+- Function: magit-start-git input &rest args ::
Start Git, prepare for refresh, and return the process object.
@@ -8068,7 +8070,7 @@ And now for the asynchronous variants.
Unmodified buffers visiting files that are tracked in the current
repository are reverted if ~magit-revert-buffers~ is non-nil.
-- Function: magit-start-process &rest args
+- Function: magit-start-process &rest args ::
Start PROGRAM, prepare for refresh, and return the process object.
@@ -8090,12 +8092,12 @@ And now for the asynchronous variants.
in the current repository are reverted if ~magit-revert-buffers~ is
non-nil.
-- Variable: magit-this-process
+- Variable: magit-this-process ::
The child process which is about to start. This can be used to
change the filter and sentinel.
-- Variable: magit-process-raise-error
+- Variable: magit-process-raise-error ::
When this is non-nil, then ~magit-process-sentinel~ raises an error if
git exits with a non-zero exit status. For debugging purposes.
@@ -8103,7 +8105,7 @@ And now for the asynchronous variants.
** Section Plumbing
*** Creating Sections
-- Macro: magit-insert-section &rest args
+- Macro: magit-insert-section &rest args ::
Insert a section at point.
@@ -8139,7 +8141,7 @@ And now for the asynchronous variants.
section by washing Git's output and Git didn't actually output
anything this time around.
-- Function: magit-insert-heading &rest args
+- Function: magit-insert-heading &rest args ::
Insert the heading for the section currently being inserted.
@@ -8166,24 +8168,24 @@ And now for the asynchronous variants.
you are responsible for getting it right. The only exception is
that this function does insert a newline character if necessary.
-- Function: magit-cancel-section
+- Function: magit-cancel-section ::
Cancel the section currently being inserted. This exits the
innermost call to ~magit-insert-section~ and removes all traces of
what has already happened inside that call.
-- Function: magit-define-section-jumper sym title &optional value
+- Function: magit-define-section-jumper sym title &optional value ::
Define an interactive function to go to section SYM. TITLE is the
displayed title of the section.
*** Section Selection
-- Function: magit-current-section
+- Function: magit-current-section ::
Return the section at point.
-- Function: magit-region-sections &optional condition multiple
+- Function: magit-region-sections &optional condition multiple ::
Return a list of the selected sections.
@@ -8210,7 +8212,7 @@ And now for the asynchronous variants.
CONDITION, or nil is returned. See ~magit-section-match~ for the
forms CONDITION can take.
-- Function: magit-region-values &optional condition multiple
+- Function: magit-region-values &optional condition multiple ::
Return a list of the values of the selected sections.
@@ -8219,22 +8221,22 @@ And now for the asynchronous variants.
*** Matching Sections
-- Key: M-x magit-describe-section-briefly, magit-describe-section-briefly
+- Key: M-x magit-describe-section-briefly ::
Show information about the section at point. This command is
intended for debugging purposes.
-- Function: magit-section-ident section
+- Function: magit-section-ident section ::
Return an unique identifier for SECTION. The return value has the
form ~((TYPE . VALUE)...)~.
-- Function: magit-get-section ident &optional root
+- Function: magit-get-section ident &optional root ::
Return the section identified by IDENT. IDENT has to be a list as
returned by ~magit-section-ident~.
-- Function: magit-section-match condition &optional section
+- Function: magit-section-match condition &optional section ::
Return ~t~ if SECTION matches CONDITION.
SECTION defaults to the section at point. If SECTION is not
@@ -8276,7 +8278,7 @@ And now for the asynchronous variants.
lineage as printed by ~magit-describe-section-briefly~, unless
of course you want to be that precise.
-- Function: magit-section-value-if condition &optional section
+- Function: magit-section-value-if condition &optional section ::
If the section at point matches CONDITION, then return its value.
@@ -8287,7 +8289,7 @@ And now for the asynchronous variants.
See ~magit-section-match~ for the forms CONDITION can take.
-- Function: magit-section-case &rest clauses
+- Function: magit-section-case &rest clauses ::
Choose among clauses on the type of the section at point.
@@ -8303,7 +8305,7 @@ And now for the asynchronous variants.
matches if no other CONDITION match, even if there is no section at
point.
-- Variable: magit-root-section
+- Variable: magit-root-section ::
The root section in the current buffer. All other sections are
descendants of this section. The value of this variable is set by
@@ -8311,7 +8313,7 @@ And now for the asynchronous variants.
For diff related sections a few additional tools exist.
-- Function: magit-diff-type &optional section
+- Function: magit-diff-type &optional section ::
Return the diff type of SECTION.
@@ -8333,7 +8335,7 @@ For diff related sections a few additional tools exist.
other means. In ~magit-revision-mode~ buffers the type is always
~committed~.
-- Function: magit-diff-scope &optional section strict
+- Function: magit-diff-scope &optional section strict ::
Return the diff scope of SECTION or the selected section(s).
@@ -8366,7 +8368,7 @@ of ~magit-refresh-function~ (a function named
~magit-*-refresh-buffer~,
where ~*~ may be something like ~diff~) with the value of
~magit-refresh-args~ as arguments.
-- Macro: magit-mode-setup buffer switch-func mode refresh-func &optional
refresh-args
+- Macro: magit-mode-setup buffer switch-func mode refresh-func &optional
refresh-args ::
This function displays and selects BUFFER, turns on MODE, and
refreshes a first time.
@@ -8380,7 +8382,7 @@ where ~*~ may be something like ~diff~) with the value of
All arguments are evaluated before switching to BUFFER.
-- Function: magit-mode-display-buffer buffer mode &optional switch-function
+- Function: magit-mode-display-buffer buffer mode &optional switch-function ::
This function display BUFFER in some window and select it. BUFFER
may be a buffer or a string, the name of a buffer. The buffer is
@@ -8394,13 +8396,13 @@ where ~*~ may be something like ~diff~) with the value
of
is ~nil~ then ~pop-to-buffer~ is used if the current buffer's major mode
derives from ~magit-mode~. Otherwise ~switch-to-buffer~ is used.
-- Variable: magit-refresh-function
+- Variable: magit-refresh-function ::
The value of this buffer-local variable is the function used to
refresh the current buffer. It is called with ~magit-refresh-args~ as
arguments.
-- Variable: magit-refresh-args
+- Variable: magit-refresh-args ::
The list of arguments used by ~magit-refresh-function~ to refresh the
current buffer. ~magit-refresh-function~ is called with these
@@ -8901,13 +8903,13 @@ appreciate it very much if you use those tools before
reporting an
issue. Please include all relevant output when reporting an
issue.
-- Key: M-x magit-version, magit-version
+- Key: M-x magit-version ::
This command shows the currently used versions of Magit, Git, and
Emacs in the echo area. Non-interactively this just returns the
Magit version.
-- Key: M-x magit-emacs-Q-command, magit-emacs-Q-command
+- Key: M-x magit-emacs-Q-command ::
This command shows a debugging shell command in the echo area and
adds it to the kill ring. Paste that command into a shell and run
@@ -8921,13 +8923,13 @@ issue.
If you run Magit from its Git repository, then you should be able to
use ~make emacs-Q~ instead of the output of this command.
-- Key: M-x magit-toggle-verbose-refresh, magit-toggle-verbose-refresh
+- Key: M-x magit-toggle-verbose-refresh ::
This command toggles whether Magit refreshes buffers verbosely.
Enabling this helps figuring out which sections are bottlenecks.
The additional output can be found in the ~*Messages*~ buffer.
-- Key: M-x magit-debug-git-executable, magit-debug-git-executable
+- Key: M-x magit-debug-git-executable ::
This command displays a buffer containing information about the
available and used ~git~ executable(s), and can be useful when
@@ -8935,7 +8937,7 @@ issue.
Also see [[*Git Executable]].
-- Key: M-x with-editor-debug, with-editor-debug
+- Key: M-x with-editor-debug ::
This command displays a buffer containing information about the
available and used ~emacsclient~ executable(s), and can be useful
@@ -8952,12 +8954,7 @@ Please also see the [[*FAQ]].
:INDEX: ky
:COOKIE_DATA: recursive
:END:
-* Command Index
-:PROPERTIES:
-:APPENDIX: t
-:INDEX: cp
-:END:
-* Function Index
+* Function and Command Index
:PROPERTIES:
:APPENDIX: t
:INDEX: fn
@@ -9011,7 +9008,6 @@ General Public License for more details.
# Local Variables:
# eval: (require 'magit-utils nil t)
# eval: (require 'ol-man nil t)
-# eval: (require 'ox-texinfo+ nil t)
# indent-tabs-mode: nil
# org-src-preserve-indentation: nil
# End:
diff --git a/docs/magit.texi b/docs/magit.texi
index 0091875462..ea7e22bb7e 100644
--- a/docs/magit.texi
+++ b/docs/magit.texi
@@ -31,7 +31,7 @@ General Public License for more details.
@finalout
@titlepage
@title Magit User Manual
-@subtitle for version 3.3.0 (v3.3.0-53-g463a3550+1)
+@subtitle for version v3.3.0-72-geb0d359dc+1
@author Jonas Bernoulli
@page
@vskip 0pt plus 1filll
@@ -53,7 +53,7 @@ directly from within Emacs. While many fine Git clients
exist, only
Magit and Git itself deserve to be called porcelains.
@noindent
-This manual is for Magit version 3.3.0 (v3.3.0-53-g463a3550+1).
+This manual is for Magit version v3.3.0-72-geb0d359dc+1.
@quotation
Copyright (C) 2015-2021 Jonas Bernoulli <jonas@@bernoul.li>
@@ -85,8 +85,7 @@ General Public License for more details.
* FAQ::
* Debugging Tools::
* Keystroke Index::
-* Command Index::
-* Function Index::
+* Function and Command Index::
* Variable Index::
@detailmenu
@@ -732,10 +731,8 @@ In this manual we often speak about "Magit buffers". By
that we mean
buffers whose major-modes derive from @code{magit-mode}.
@table @asis
-@kindex M-x magit-toggle-buffer-lock
-@cindex magit-toggle-buffer-lock
-@item @kbd{M-x magit-toggle-buffer-lock}
@tie{}@tie{}@tie{}@tie{}(@code{magit-toggle-buffer-lock})
-
+@item @kbd{M-x magit-toggle-buffer-lock}
+@findex magit-toggle-buffer-lock
This command locks the current buffer to its value or if the buffer
is already locked, then it unlocks it.
@@ -767,7 +764,6 @@ displayed in its place.
@subsection Switching Buffers
@defun magit-display-buffer buffer &optional display-function
-
This function is a wrapper around @code{display-buffer} and is used to
display any Magit buffer. It displays BUFFER in some window and,
unlike @code{display-buffer}, also selects that window, provided
@@ -780,7 +776,6 @@ by @code{magit-display-buffer-function} is used.
@end defun
@defvar magit-display-buffer-noselect
-
When this is non-nil, then @code{magit-display-buffer} only displays the
buffer but forgoes also selecting the window. This variable should
not be set globally, it is only intended to be let-bound, by code
@@ -790,7 +785,6 @@ log buffer.
@end defvar
@defopt magit-display-buffer-function
-
The function specified here is called by @code{magit-display-buffer} with
one argument, a buffer, to actually display that buffer. This
function should call @code{display-buffer} with that buffer as first and a
@@ -809,7 +803,6 @@ To learn about display actions, see @ref{Choosing
Window,,,elisp,}.
@end defopt
@defun magit-display-buffer-traditional buffer
-
This function is the current default value of the option
@code{magit-display-buffer-function}. Before that option and this function
were added, the behavior was hard-coded in many places all over the
@@ -818,21 +811,18 @@ code base but now all the rules are contained in this one
function
@end defun
@defun magit-display-buffer-same-window-except-diff-v1
-
This function displays most buffers in the currently selected
window. If a buffer's mode derives from @code{magit-diff-mode} or
@code{magit-process-mode}, it is displayed in another window.
@end defun
@defun magit-display-buffer-fullframe-status-v1
-
This function fills the entire frame when displaying a status
buffer. Otherwise, it behaves like
@code{magit-display-buffer-traditional}.
@end defun
@defun magit-display-buffer-fullframe-status-topleft-v1
-
This function fills the entire frame when displaying a status
buffer. It behaves like @code{magit-display-buffer-fullframe-status-v1}
except that it displays buffers that derive from @code{magit-diff-mode}
@@ -843,7 +833,6 @@ to pop up on the same side as they would if
@end defun
@defun magit-display-buffer-fullcolumn-most-v1
-
This function displays most buffers so that they fill the entire
height of the frame. However, the buffer is displayed in another
window if (1) the buffer's mode derives from @code{magit-process-mode},
@@ -853,26 +842,22 @@ that the mode of the current buffer derives from
@code{magit-log-mode} or
@end defun
@defopt magit-pre-display-buffer-hook
-
This hook is run by @code{magit-display-buffer} before displaying the
buffer.
@end defopt
@defun magit-save-window-configuration
-
This function saves the current window configuration. Later when
the buffer is buried, it may be restored by
@code{magit-restore-window-configuration}.
@end defun
@defopt magit-post-display-buffer-hook
-
This hook is run by @code{magit-display-buffer} after displaying the
buffer.
@end defopt
@defun magit-maybe-set-dedicated
-
This function remembers if a new window had to be created to display
the buffer, or whether an existing window was reused. This
information is later used by @code{magit-mode-quit-window}, to determine
@@ -884,7 +869,6 @@ buried.
@subsection Naming Buffers
@defopt magit-generate-buffer-name-function
-
The function used to generate the names of Magit buffers.
Such a function should take the options @code{magit-uniquify-buffer-names}
@@ -896,7 +880,6 @@ the additions.
@end defopt
@defun magit-generate-buffer-name-default-function mode
-
This function returns a buffer name suitable for a buffer whose
major-mode is MODE and which shows information about the repository
in which @code{default-directory} is located.
@@ -907,7 +890,6 @@ respects the option @code{magit-uniquify-buffer-names}.
@end defun
@defopt magit-buffer-name-format
-
The format string used to name Magit buffers.
At least the following %-sequences are supported:
@@ -918,34 +900,29 @@ At least the following %-sequences are supported:
The name of the major-mode, but with the @code{-mode} suffix removed.
-
@item
@code{%M}
Like @code{%m} but abbreviate @code{magit-status-mode} as @code{magit}.
-
@item
@code{%v}
The value the buffer is locked to, in parentheses, or an empty
string if the buffer is not locked to a value.
-
@item
@code{%V}
Like @code{%v}, but the string is prefixed with a space, unless it is an
empty string.
-
@item
@code{%t}
The top-level directory of the working tree of the repository, or
if @code{magit-uniquify-buffer-names} is non-nil an abbreviation of that.
-
@item
@code{%x}
@@ -953,7 +930,6 @@ If @code{magit-uniquify-buffer-names} is nil "*", otherwise
the empty
string. Due to limitations of the @code{uniquify} package, buffer names
must end with the path.
-
@item
@code{%T}
@@ -968,7 +944,6 @@ value must end with @code{%t} or @code{%t%x} (or the
obsolete @code{%T}). See i
@end defopt
@defopt magit-uniquify-buffer-names
-
This option controls whether the names of Magit buffers are
uniquified. If the names are not being uniquified, then they
contain the full path of the top-level of the working tree of the
@@ -985,20 +960,17 @@ control how buffer names are uniquified.
@subsection Quitting Windows
@table @asis
+@item @kbd{q} (@code{magit-mode-bury-buffer})
@kindex q
-@cindex magit-mode-bury-buffer
-@item @kbd{q} @tie{}@tie{}@tie{}@tie{}(@code{magit-mode-bury-buffer})
-
+@findex magit-mode-bury-buffer
This command buries the current Magit buffer.
With a prefix argument, it instead kills the buffer. With a double
prefix argument, also kills all other Magit buffers associated with
the current project.
-
@end table
@defopt magit-bury-buffer-function
-
The function used to actually bury or kill the current buffer.
@code{magit-mode-bury-buffer} calls this function with one argument. If
@@ -1008,7 +980,6 @@ currently is @code{magit-restore-window-configuration}.
@end defopt
@defun magit-restore-window-configuration kill-buffer
-
Bury or kill the current buffer using @code{quit-window}, which is called
with KILL-BUFFER as first and the selected window as second
argument.
@@ -1020,7 +991,6 @@ are being displayed in the selected frame.
@end defun
@defun magit-mode-quit-window kill-buffer
-
Bury or kill the current buffer using @code{quit-window}, which is called
with KILL-BUFFER as first and the selected window as second
argument.
@@ -1055,10 +1025,9 @@ that weren't current during the last refresh and after
changes were
made to the repository outside of Magit.
@table @asis
+@item @kbd{g} (@code{magit-refresh})
@kindex g
-@cindex magit-refresh
-@item @kbd{g} @tie{}@tie{}@tie{}@tie{}(@code{magit-refresh})
-
+@findex magit-refresh
This command refreshes the current buffer if its major mode derives
from @code{magit-mode} as well as the corresponding status buffer.
@@ -1066,27 +1035,23 @@ If the option @code{magit-revert-buffers} calls for it,
then it also
reverts all unmodified buffers that visit files being tracked in the
current repository.
+@item @kbd{G} (@code{magit-refresh-all})
@kindex G
-@cindex magit-refresh-all
-@item @kbd{G} @tie{}@tie{}@tie{}@tie{}(@code{magit-refresh-all})
-
+@findex magit-refresh-all
This command refreshes all Magit buffers belonging to the current
repository and also reverts all unmodified buffers that visit files
being tracked in the current repository.
The file-visiting buffers are always reverted, even if
@code{magit-revert-buffers} is nil.
-
@end table
@defopt magit-refresh-buffer-hook
-
This hook is run in each Magit buffer that was refreshed during the
current refresh - normally the current buffer and the status buffer.
@end defopt
@defopt magit-refresh-status-buffer
-
When this option is non-nil, then the status buffer is automatically
refreshed after running git for side-effects, in addition to the
current Magit buffer, which is always refreshed automatically.
@@ -1096,7 +1061,6 @@ performance.
@end defopt
@defun magit-after-save-refresh-status
-
This function is intended to be added to @code{after-save-hook}. After
doing that the corresponding status buffer is refreshed whenever a
buffer is saved to a file inside a repository.
@@ -1118,7 +1082,6 @@ doubt or after outside changes, type @code{g}
(@code{magit-refresh}) to save and
refresh explicitly.
@defopt magit-save-repository-buffers
-
This option controls whether file-visiting buffers are saved before
certain events.
@@ -1144,13 +1107,11 @@ the buffer, then you would have to type @code{M-x
revert-buffer RET RET} in
the visiting buffer before you could continue making changes.
@defopt magit-auto-revert-mode
-
When this mode is enabled, then buffers that visit tracked files
are automatically reverted after the visited files change on disk.
@end defopt
@defopt global-auto-revert-mode
-
When this mode is enabled, then any file-visiting buffer is
automatically reverted after the visited file changes on disk.
@@ -1161,7 +1122,6 @@ this mode @emph{instead of} @code{magit-auto-revert-mode}.
@end defopt
@defopt magit-auto-revert-immediately
-
This option controls whether Magit reverts buffers immediately.
If this is non-nil and either @code{global-auto-revert-mode} or
@@ -1179,14 +1139,12 @@ inactivity. That is not desirable.
@end defopt
@defopt auto-revert-use-notify
-
This option controls whether file notification functions should be
used. Note that this variable unfortunately defaults to @code{t} even on
systems on which file notifications cannot be used.
@end defopt
@defopt magit-auto-revert-tracked-only
-
This option controls whether @code{magit-auto-revert-mode} only reverts
tracked files or all files that are located inside Git repositories,
including untracked files and files located inside Git's control
@@ -1194,7 +1152,6 @@ directory.
@end defopt
@defopt auto-revert-mode
-
The global mode @code{magit-auto-revert-mode} works by turning on this
local mode in the appropriate buffers (but @code{global-auto-revert-mode}
is implemented differently). You can also turn it on or off
@@ -1203,19 +1160,16 @@ previously untracked file now is being tracked or
vice-versa.
@end defopt
@defopt auto-revert-stop-on-user-input
-
This option controls whether the arrival of user input suspends the
automatic reverts for @code{auto-revert-interval} seconds.
@end defopt
@defopt auto-revert-interval
-
This option controls how many seconds Emacs waits for before
resuming suspended reverts.
@end defopt
@defopt auto-revert-buffer-list-filter
-
This option specifies an additional filter used by
@code{auto-revert-buffers} to determine whether a buffer should be reverted
or not.
@@ -1237,7 +1191,6 @@ option, because it is disregarded if the global mode is
enabled.
@end defopt
@defopt auto-revert-verbose
-
This option controls whether Emacs reports when a buffer has been
reverted.
@end defopt
@@ -1324,39 +1277,34 @@ whose global bindings are not shadowed. To move to
another section use
the following commands.
@table @asis
+@item @kbd{p} (@code{magit-section-backward})
@kindex p
-@cindex magit-section-backward
-@item @kbd{p} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-backward})
-
+@findex magit-section-backward
When not at the beginning of a section, then move to the beginning
of the current section. At the beginning of a section, instead move
to the beginning of the previous visible section.
+@item @kbd{n} (@code{magit-section-forward})
@kindex n
-@cindex magit-section-forward
-@item @kbd{n} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-forward})
-
+@findex magit-section-forward
Move to the beginning of the next visible section.
+@item @kbd{M-p} (@code{magit-section-backward-siblings})
@kindex M-p
-@cindex magit-section-backward-siblings
-@item @kbd{M-p}
@tie{}@tie{}@tie{}@tie{}(@code{magit-section-backward-siblings})
-
+@findex magit-section-backward-siblings
Move to the beginning of the previous sibling section. If there is
no previous sibling section, then move to the parent section
instead.
+@item @kbd{M-n} (@code{magit-section-forward-siblings})
@kindex M-n
-@cindex magit-section-forward-siblings
-@item @kbd{M-n} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-forward-siblings})
-
+@findex magit-section-forward-siblings
Move to the beginning of the next sibling section. If there is no
next sibling section, then move to the parent section instead.
+@item @kbd{^} (@code{magit-section-up})
@kindex ^
-@cindex magit-section-up
-@item @kbd{^} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-up})
-
+@findex magit-section-up
Move to the beginning of the parent of the current section.
@end table
@@ -1374,13 +1322,11 @@ 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.
@end defvar
@defun magit-hunk-set-window-start
-
This hook function ensures that the beginning of the current section
is visible, provided it is a @code{hunk} section. Otherwise, it does
nothing.
@@ -1389,7 +1335,6 @@ Loading @code{magit-diff} adds this function to the hook.
@end defun
@defun magit-section-set-window-start
-
This hook function ensures that the beginning of the current section
is visible, regardless of the section's type. If you add this to
@code{magit-section-movement-hook}, then you must remove the hunk-only
@@ -1397,7 +1342,6 @@ variant in turn.
@end defun
@defun magit-log-maybe-show-more-commits
-
This hook function only has an effect in log buffers, and @code{point} is
on the "show more" section. If that is the case, then it doubles
the number of commits that are being shown.
@@ -1406,7 +1350,6 @@ Loading @code{magit-log} adds this function to the hook.
@end defun
@defun magit-log-maybe-update-revision-buffer
-
When moving inside a log buffer, then this function updates the
revision buffer, provided it is already being displayed in another
window of the same frame.
@@ -1415,42 +1358,36 @@ Loading @code{magit-log} adds this function to the hook.
@end defun
@defun magit-log-maybe-update-blob-buffer
-
When moving inside a log buffer and another window of the same frame
displays a blob buffer, then this function instead displays the blob
buffer for the commit at point in that window.
@end defun
@defun magit-status-maybe-update-revision-buffer
-
When moving inside a status buffer, then this function updates the
revision buffer, provided it is already being displayed in another
window of the same frame.
@end defun
@defun magit-status-maybe-update-stash-buffer
-
When moving inside a status buffer, then this function updates the
stash buffer, provided it is already being displayed in another
window of the same frame.
@end defun
@defun magit-status-maybe-update-blob-buffer
-
When moving inside a status buffer and another window of the same
frame displays a blob buffer, then this function instead displays
the blob buffer for the commit at point in that window.
@end defun
@defun magit-stashes-maybe-update-stash-buffer
-
When moving inside a buffer listing stashes, then this function
updates the stash buffer, provided it is already being displayed
in another window of the same frame.
@end defun
@defopt magit-update-other-window-delay
-
Delay before automatically updating the other window.
When moving around in certain buffers, then certain other buffers,
@@ -1472,58 +1409,52 @@ Magit provides many commands for changing the
visibility of sections,
but all you need to get started are the next two.
@table @asis
+@item @kbd{@key{TAB}} (@code{magit-section-toggle})
@kindex TAB
-@cindex magit-section-toggle
-@item @kbd{TAB} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-toggle})
-
+@findex magit-section-toggle
Toggle the visibility of the body of the current section.
+@item @kbd{C-<tab>} (@code{magit-section-cycle})
@kindex C-<tab>
-@cindex magit-section-cycle
-@item @kbd{C-<tab>} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-cycle})
-
+@findex magit-section-cycle
Cycle the visibility of current section and its children.
+@item @kbd{M-<tab>} (@code{magit-section-cycle-diffs})
@kindex M-<tab>
-@cindex magit-section-cycle-diffs
-@item @kbd{M-<tab>} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-cycle-diffs})
-
+@findex magit-section-cycle-diffs
Cycle the visibility of diff-related sections in the current buffer.
+@item @kbd{S-<tab>} (@code{magit-section-cycle-global})
@kindex S-<tab>
-@cindex magit-section-cycle-global
-@item @kbd{S-<tab>} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-cycle-global})
-
+@findex magit-section-cycle-global
Cycle the visibility of all sections in the current buffer.
+@item @kbd{1} (@code{magit-section-show-level-1})
+@itemx @kbd{2} (@code{magit-section-show-level-2})
+@itemx @kbd{3} (@code{magit-section-show-level-3})
+@itemx @kbd{4} (@code{magit-section-show-level-4})
@kindex 1
-@cindex magit-section-show-level-1
-@item @kbd{1} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-show-level-1})
@kindex 2
-@cindex magit-section-show-level-2
-@item @kbd{2} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-show-level-2})
@kindex 3
-@cindex magit-section-show-level-3
-@item @kbd{3} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-show-level-3})
@kindex 4
-@cindex magit-section-show-level-4
-@item @kbd{4} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-show-level-4})
-
+@findex magit-section-show-level-1
+@findex magit-section-show-level-2
+@findex magit-section-show-level-3
+@findex magit-section-show-level-4
Show sections surrounding the current section up to level N@.
+@item @kbd{M-1} (@code{magit-section-show-level-1-all})
+@itemx @kbd{M-2} (@code{magit-section-show-level-2-all})
+@itemx @kbd{M-3} (@code{magit-section-show-level-3-all})
+@itemx @kbd{M-4} (@code{magit-section-show-level-4-all})
@kindex M-1
-@cindex magit-section-show-level-1-all
-@item @kbd{M-1} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-show-level-1-all})
@kindex M-2
-@cindex magit-section-show-level-2-all
-@item @kbd{M-2} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-show-level-2-all})
@kindex M-3
-@cindex magit-section-show-level-3-all
-@item @kbd{M-3} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-show-level-3-all})
@kindex M-4
-@cindex magit-section-show-level-4-all
-@item @kbd{M-4} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-show-level-4-all})
-
+@findex magit-section-show-level-1-all
+@findex magit-section-show-level-2-all
+@findex magit-section-show-level-3-all
+@findex magit-section-show-level-4-all
Show all sections up to level N@.
@end table
@@ -1532,42 +1463,30 @@ also exposed as commands themselves. By default no
keys are bound to
these commands, as they are generally perceived to be much less
useful. But your mileage may vary.
-@cindex magit-section-show
@deffn Command magit-section-show
-
Show the body of the current section.
@end deffn
-@cindex magit-section-hide
@deffn Command magit-section-hide
-
Hide the body of the current section.
@end deffn
-@cindex magit-section-show-headings
@deffn Command magit-section-show-headings
-
Recursively show headings of children of the current section. Only
show the headings. Previously shown text-only bodies are hidden.
@end deffn
-@cindex magit-section-show-children
@deffn Command magit-section-show-children
-
Recursively show the bodies of children of the current section.
With a prefix argument show children down to the level of the
current section, and hide deeper children.
@end deffn
-@cindex magit-section-hide-children
@deffn Command magit-section-hide-children
-
Recursively hide the bodies of children of the current section.
@end deffn
-@cindex magit-section-toggle-children
@deffn Command magit-section-toggle-children
-
Toggle visibility of bodies of children of the current section.
@end deffn
@@ -1578,7 +1497,6 @@ certain sections can also be overwritten using the hook
@code{magit-section-set-visibility-hook}.
@defopt magit-section-initial-visibility-alist
-
This options can be used to override the initial visibility of
sections. In the future it will also be used to define the
defaults, but currently a section's default is still hardcoded.
@@ -1595,7 +1513,6 @@ can be used, see @code{magit-section-match}.
@end defopt
@defopt magit-section-cache-visibility
-
This option controls for which sections the previous visibility
state should be restored if a section disappears and later appears
again. The value is a boolean or a list of section types. If t,
@@ -1607,7 +1524,6 @@ a member of @code{magit-section-set-visibility-hook}.
@end defopt
@defvar magit-section-set-visibility-hook
-
This hook is run when first creating a buffer and also when
refreshing an existing buffer, and is used to determine the
visibility of the section currently being inserted.
@@ -1625,7 +1541,6 @@ immediately return @code{nil}.
@end defvar
@defopt magit-section-visibility-indicator
-
This option controls whether and how to indicate that a section can
be expanded/collapsed.
@@ -1648,7 +1563,6 @@ To provide extra padding around the indicator, set
(setq left-fringe-width 20)))
@end lisp
-
@item
@code{(STRING . BOOLEAN)}
@@ -1679,7 +1593,6 @@ The various available section hook variables are
described later in
this manual along with the appropriate "section inserter functions".
@defun magit-add-section-hook hook function &optional at append local
-
Add the function FUNCTION to the value of section hook HOOK@.
Add FUNCTION at the beginning of the hook list unless optional
@@ -1719,18 +1632,14 @@ Users usually do not have to worry about a section's
type and value,
but knowing them can be handy at times.
@table @asis
+@item @kbd{H} (@code{magit-describe-section})
@kindex H
-@cindex magit-describe-section
-@item @kbd{H} @tie{}@tie{}@tie{}@tie{}(@code{magit-describe-section})
-
+@findex magit-describe-section
This command shows information about the section at point in a
separate buffer.
-
@end table
-@cindex magit-describe-section-briefly
@deffn Command magit-describe-section-briefly
-
This command shows information about the section at point in the
echo area, as @code{#<magit-section VALUE [TYPE PARENT-TYPE...]
BEGINNING-END>}.
@@ -1754,7 +1663,6 @@ This section describes options that have an effect on
more than just a
certain type of sections. As you can see there are not many of those.
@defopt magit-section-show-child-count
-
Whether to append the number of children to section headings. This
only affects sections that could benefit from this information.
@end defopt
@@ -1775,10 +1683,9 @@ used the package @code{magit-popup} and even earlier
versions library
Transient is documented in @ref{Top,,,transient,}.
@table @asis
+@item @kbd{C-c C-c} (@code{magit-dispatch})
@kindex C-c C-c
-@cindex magit-dispatch
-@item @kbd{C-c C-c} @tie{}@tie{}@tie{}@tie{}(@code{magit-dispatch})
-
+@findex magit-dispatch
This transient prefix command binds most of Magit's other prefix
commands as suffix commands and displays them in a temporary buffer
until one of them is invoked. Invoking such a sub-prefix causes the
@@ -1856,7 +1763,6 @@ arguments are reset to the default. Not cool; so Magit
does not do
that by default.
@defopt magit-prefix-use-buffer-arguments
-
This option controls whether the infix arguments initially shown in
certain transient prefix commands are based on the arguments that
are currently in effect in the buffer that their suffixes update.
@@ -1866,7 +1772,6 @@ by this option.
@end defopt
@defopt magit-direct-use-buffer-arguments
-
This option controls whether certain commands, when invoked directly
(i.e. not as the suffix of a transient prefix command), use the
arguments that are currently active in the buffer that they are
@@ -1882,16 +1787,13 @@ Valid values for both of the above options are:
@item
@code{always}: Always use the set of arguments that is currently active
in the respective buffer, provided that buffer exists of course.
-
@item
@code{selected} or @code{t}: Use the set of arguments from the respective
buffer, but only if it is displayed in a window of the current
frame. This is the default for both variables.
-
@item
@code{current}: Use the set of arguments from the respective buffer, but
only if it is the current buffer.
-
@item
@code{never}: Never use the set of arguments from the respective buffer.
@end itemize
@@ -1908,13 +1810,11 @@ and @code{magit-status-mode} buffers. Setting or
saving the value for one
mode does not change the value for other modes. The history however
is shared.
-
@item
When @code{magit-show-commit} is invoked directly from a log buffer, then
the file filter is picked up from that buffer, not from the revision
buffer or the mode's global diff arguments.
-
@item
Even though they are suffixes of the diff prefix @code{magit-show-commit}
and @code{magit-stash-show} do not use the diff buffer used by the diff
@@ -1928,12 +1828,10 @@ buffer. However if you invoke one of these commands
directly, then
Magit knows that it should use the arguments from the revision resp.
stash buffer.
-
@item
The log prefix also features reflog commands, but these commands do
not use the log arguments.
-
@item
If @code{magit-show-refs} is invoked from a @code{magit-refs-mode} buffer,
then it
acts as a refresh prefix and therefore unconditionally uses the
@@ -1972,7 +1870,6 @@ specific set of actions, the next section explains
another way of
telling Magit to ask fewer questions.
@defopt magit-no-confirm
-
The value of this option is a list of symbols, representing actions
that do not have to be confirmed by the user before being carried
out.
@@ -1993,12 +1890,10 @@ Applying changes:
@code{discard} Discarding one or more changes (i.e. hunks or the
complete diff for a file) loses that change, obviously.
-
@item
@code{reverse} Reverting one or more changes can usually be undone by
reverting the reversion.
-
@item
@code{stage-all-changes}, @code{unstage-all-changes} When there are both
staged and unstaged changes, then un-/staging everything would
@@ -2008,7 +1903,6 @@ that so often that having to confirm every time would be
unacceptable.
@end itemize
-
@item
Files:
@@ -2018,29 +1912,24 @@ Files:
then it is completely lost, not just the last changes. Very
dangerous.
-
@item
@code{trash} Instead of deleting a file it can also be move to the
system trash. Obviously much less dangerous than deleting it.
Also see option @code{magit-delete-by-moving-to-trash}.
-
@item
@code{resurrect} A deleted file can easily be resurrected by "deleting"
the deletion, which is done using the same command that was used
to delete the same file in the first place.
-
@item
@code{untrack} Untracking a file can be undone by tracking it again.
-
@item
@code{rename} Renaming a file can easily be undone.
@end itemize
-
@item
Sequences:
@@ -2049,23 +1938,19 @@ Sequences:
@code{reset-bisect} Aborting (known to Git as "resetting") a bisect
operation loses all information collected so far.
-
@item
@code{abort-rebase} Aborting a rebase throws away all already modified
commits, but it's possible to restore those from the reflog.
-
@item
@code{abort-merge} Aborting a merge throws away all conflict
resolutions which have already been carried out by the user.
-
@item
@code{merge-dirty} Merging with a dirty worktree can make it hard to go
back to the state before the merge was initiated.
@end itemize
-
@item
References:
@@ -2078,7 +1963,6 @@ confirm the deletion of a branch by accepting the default
choice
(or selecting another branch), but when a branch has not been
merged yet, also make sure the user is aware of that.
-
@item
@code{delete-pr-remote} When deleting a branch that was created from a
pull-request and if no other branches still exist on that
@@ -2087,7 +1971,6 @@ as well. This should be safe because it only happens if
no
other refs exist in the remotes namespace, and you can recreate
the remote if necessary.
-
@item
@code{drop-stashes} Dropping a stash is dangerous because Git stores
stashes in the reflog. Once a stash is removed, there is no
@@ -2098,7 +1981,6 @@ This action only concerns the deletion of multiple
stashes at
once.
@end itemize
-
@item
Publishing:
@@ -2112,7 +1994,6 @@ repository is configured to disallow fixing such
mistakes, then
that can be quite embarrassing and annoying.
@end itemize
-
@item
Edit published history:
@@ -2124,14 +2005,12 @@ branches listed in @code{magit-published-branches}.
@item
@code{amend-published} Affects most commands that amend to "HEAD".
-
@item
@code{rebase-published} Affects commands that perform interactive
rebases. This includes commands from the commit transient that
modify a commit other than "HEAD", namely the various fixup and
squash variants.
-
@item
@code{edit-published} Affects the commands @code{magit-edit-line-commit} and
@code{magit-diff-edit-hunk-commit}. These two commands make it quite
@@ -2142,7 +2021,6 @@ think twice before configuring them not to ask for
confirmation.
To disable confirmation completely, add all three symbols here or
set @code{magit-published-branches} to @code{nil}.
-
@item
Various:
@@ -2151,7 +2029,6 @@ Various:
@code{kill-process} There seldom is a reason to kill a process.
@end itemize
-
@item
Global settings:
@@ -2211,7 +2088,6 @@ not affected by this option and are described in the
previous section.
@defopt magit-dwim-selection
@end defopt
-
This option can be used to tell certain commands to use the thing
at point instead of asking the user to select a candidate to act
on, with or without confirmation.
@@ -2225,14 +2101,12 @@ To have an effect, the command has to use the function
@code{magit-completing-read} or a utility function which in turn uses
that function.
-
@item
If the command uses @code{magit-completing-read} multiple times, then
PROMPT can be used to only affect one of these uses. PROMPT, if
non-nil, is a regular expression that is used to match against
the PROMPT argument passed to @code{magit-completing-read}.
-
@item
DEFAULT specifies how to use the default. If it is @code{t}, then
the DEFAULT argument passed to @code{magit-completing-read} is used
@@ -2291,7 +2165,6 @@ the current section always is part of the selection, then
that cannot
happen.
@defvar magit-keep-region-overlay
-
This variable controls whether the region is visualized as usual
even when a valid Magit selection or a hunk-internal region exists.
See the doc-string for more information.
@@ -2343,7 +2216,6 @@ will also have to install the @code{ido-completing-read+}
package and use
@code{magit-ido-completing-read} as @code{magit-completing-read-function}.
@defopt magit-completing-read-function
-
The value of this variable is the low-level function used to perform
completion by code that uses @code{magit-completing-read} (as opposed to
the built-in @code{completing-read}).
@@ -2358,13 +2230,11 @@ the same.
@end defopt
@defun magit-builtin-completing-read prompt choices &optional predicate
require-match initial-input hist def
-
This function performs completion using the built-in @code{completing-read}
and does some additional magit-specific work.
@end defun
@defun magit-ido-completing-read prompt choices &optional predicate
require-match initial-input hist def
-
This function performs completion using @code{ido-completing-read+} from the
package by the same name (which you have to explicitly install) and
does some additional magit-specific work.
@@ -2376,7 +2246,6 @@ because it violates too many of the implicit conventions.
@end defun
@defun magit-completing-read prompt choices &optional predicate require-match
initial-input hist def fallback
-
This is the function that Magit commands use when they need the user
to select a single thing to act on. The arguments have the same
meaning as for @code{completing-read}, except for FALLBACK, which is unique
@@ -2396,17 +2265,14 @@ similar to @code{completing-read}, except for the
following:
COLLECTION must be a list of choices. A function is not
supported.
-
@item
If REQUIRE-MATCH is @code{nil} and the user exits without a choice, then
@code{nil} is returned instead of an empty string.
-
@item
If REQUIRE-MATCH is non-nil and the users exits without a choice,
an user-error is raised.
-
@item
FALLBACK specifies a secondary default that is only used if the
primary default DEF is @code{nil}. The secondary default is not subject
@@ -2414,11 +2280,9 @@ to @code{magit-dwim-selection} — if DEF is @code{nil}
but FALLBACK is not, the
this function always asks the user to choose a candidate, just as
if both defaults were @code{nil}.
-
@item
": " is appended to PROMPT@.
-
@item
PROMPT is modified to end with \" (default DEF|FALLBACK): \"
provided that DEF or FALLBACK is non-nil, that neither @code{ivy-mode}
@@ -2432,7 +2296,6 @@ nor @code{helm-mode} is enabled, and that
@subsection Additional Completion Options
@defopt magit-list-refs-sortby
-
For many commands that read a ref or refs from the user, the value
of this option can be used to control the order of the refs. Valid
values include any key accepted by the @code{--sort} flag of @code{git
@@ -2465,10 +2328,9 @@ The output/errors for up to `magit-process-log-max' Git
commands are
retained.
@table @asis
+@item @kbd{$} (@code{magit-process})
@kindex $
-@cindex magit-process
-@item @kbd{$} @tie{}@tie{}@tie{}@tie{}(@code{magit-process})
-
+@findex magit-process
This commands displays the process buffer for the current
repository.
@end table
@@ -2477,16 +2339,13 @@ Inside that buffer, the usual key bindings for
navigating and showing
sections are available. There is one additional command.
@table @asis
+@item @kbd{k} (@code{magit-process-kill})
@kindex k
-@cindex magit-process-kill
-@item @kbd{k} @tie{}@tie{}@tie{}@tie{}(@code{magit-process-kill})
-
+@findex magit-process-kill
This command kills the process represented by the section at point.
-
@end table
@defvar magit-git-debug
-
This option controls whether additional reporting of git errors is
enabled.
@@ -2506,7 +2365,6 @@ permanently, that would negatively affect performance.
@end defvar
@defvar magit-process-extreme-logging
-
This option controls whether @code{magit-process-file} logs to the
@code{*Messages*} buffer.
@@ -2547,30 +2405,27 @@ commands by typing them into the minibuffer, instead of
having to
switch to a shell.
@table @asis
+@item @kbd{!} (@code{magit-run})
@kindex !
-@cindex magit-run
-@item @kbd{!} @tie{}@tie{}@tie{}@tie{}(@code{magit-run})
-
+@findex magit-run
This transient prefix command binds the following suffix commands
and displays them in a temporary buffer until a suffix is invoked.
+@item @kbd{! !} (@code{magit-git-command-topdir})
@kindex ! !
-@cindex magit-git-command-topdir
-@item @kbd{! !} @tie{}@tie{}@tie{}@tie{}(@code{magit-git-command-topdir})
-
+@findex magit-git-command-topdir
This command reads a command from the user and executes it in the
top-level directory of the current working tree.
The string "git " is used as initial input when prompting the user
for the command. It can be removed to run another command.
+@item @kbd{:} (@code{magit-git-command})
@kindex :
-@cindex magit-git-command
-@item @kbd{:} @tie{}@tie{}@tie{}@tie{}(@code{magit-git-command})
-@kindex ! p
-@cindex magit-git-command
-@item @kbd{! p} @tie{}@tie{}@tie{}@tie{}(@code{magit-git-command})
+@findex magit-git-command
+@item @kbd{! p}
+@kindex ! p
This command reads a command from the user and executes it in
@code{default-directory}. With a prefix argument the command is executed
in the top-level directory of the current working tree instead.
@@ -2578,25 +2433,21 @@ in the top-level directory of the current working tree
instead.
The string "git " is used as initial input when prompting the user
for the command. It can be removed to run another command.
+@item @kbd{! s} (@code{magit-shell-command-topdir})
@kindex ! s
-@cindex magit-shell-command-topdir
-@item @kbd{! s} @tie{}@tie{}@tie{}@tie{}(@code{magit-shell-command-topdir})
-
+@findex magit-shell-command-topdir
This command reads a command from the user and executes it in the
top-level directory of the current working tree.
+@item @kbd{! S} (@code{magit-shell-command})
@kindex ! S
-@cindex magit-shell-command
-@item @kbd{! S} @tie{}@tie{}@tie{}@tie{}(@code{magit-shell-command})
-
+@findex magit-shell-command
This command reads a command from the user and executes it in
@code{default-directory}. With a prefix argument the command is executed
in the top-level directory of the current working tree instead.
-
@end table
@defopt magit-shell-command-verbose-prompt
-
Whether the prompt, used by the above commands when reading a
shell command, shows the directory in which it will be run.
@end defopt
@@ -2604,28 +2455,24 @@ shell command, shows the directory in which it will be
run.
These suffix commands start external gui tools.
@table @asis
+@item @kbd{! k} (@code{magit-run-gitk})
@kindex ! k
-@cindex magit-run-gitk
-@item @kbd{! k} @tie{}@tie{}@tie{}@tie{}(@code{magit-run-gitk})
-
+@findex magit-run-gitk
This command runs @code{gitk} in the current repository.
+@item @kbd{! a} (@code{magit-run-gitk-all})
@kindex ! a
-@cindex magit-run-gitk-all
-@item @kbd{! a} @tie{}@tie{}@tie{}@tie{}(@code{magit-run-gitk-all})
-
+@findex magit-run-gitk-all
This command runs @code{gitk --all} in the current repository.
+@item @kbd{! b} (@code{magit-run-gitk-branches})
@kindex ! b
-@cindex magit-run-gitk-branches
-@item @kbd{! b} @tie{}@tie{}@tie{}@tie{}(@code{magit-run-gitk-branches})
-
+@findex magit-run-gitk-branches
This command runs @code{gitk --branches} in the current repository.
+@item @kbd{! g} (@code{magit-run-git-gui})
@kindex ! g
-@cindex magit-run-git-gui
-@item @kbd{! g} @tie{}@tie{}@tie{}@tie{}(@code{magit-run-git-gui})
-
+@findex magit-run-git-gui
This command runs @code{git gui} in the current repository.
@end table
@@ -2653,7 +2500,6 @@ on the local machine, so a separate option is used to
control the name
or path that is used on remote machines.
@defopt magit-git-executable
-
The @code{git} executable used by Magit on the local host. This should be
either the absolute path to the executable, or the string "git" to
let Emacs find the executable itself, using the standard mechanism
@@ -2661,7 +2507,6 @@ for doing such things.
@end defopt
@defopt magit-remote-git-executable
-
The @code{git} executable used by Magit on remote machines over Tramp.
Normally this should be just the string "git". Consider customizing
@code{tramp-remote-path} instead of this option.
@@ -2684,17 +2529,13 @@ The command @code{magit-debug-git-executable} can be
useful to find out where
Emacs is searching for @code{git}.
@table @asis
-@kindex M-x magit-debug-git-executable
-@cindex magit-debug-git-executable
-@item @kbd{M-x magit-debug-git-executable}
@tie{}@tie{}@tie{}@tie{}(@code{magit-debug-git-executable})
-
+@item @kbd{M-x magit-debug-git-executable}
+@findex magit-debug-git-executable
This command displays a buffer with information about
@code{magit-git-executable} and @code{magit-remote-git-executable}.
-@kindex M-x magit-version
-@cindex magit-version
-@item @kbd{M-x magit-version} @tie{}@tie{}@tie{}@tie{}(@code{magit-version})
-
+@item @kbd{M-x magit-version}
+@findex magit-version
This command shows the currently used versions of Magit, Git, and
Emacs in the echo area. Non-interactively this just returns the
Magit version.
@@ -2704,7 +2545,6 @@ Magit version.
@subsection Global Git Arguments
@defopt magit-git-global-arguments
-
The arguments set here are used every time the git executable is run
as a subprocess. They are placed right after the executable itself
and before the git command - as in @code{git HERE... COMMAND REST}. For
@@ -2781,10 +2621,9 @@ that it should be bound globally. We recommend using
@code{C-x g}:
@end lisp
@table @asis
+@item @kbd{C-x g} (@code{magit-status})
@kindex C-x g
-@cindex magit-status
-@item @kbd{C-x g} @tie{}@tie{}@tie{}@tie{}(@code{magit-status})
-
+@findex magit-status
When invoked from within an existing Git repository, then this
command shows the status of that repository in a buffer.
@@ -2798,14 +2637,12 @@ the status for the selected repository is shown instead.
If that option specifies any existing repositories, then the user
is asked to select one of them.
-
@item
Otherwise the user is asked to select an arbitrary directory using
regular file-name completion. If the selected directory is the
top-level directory of an existing working tree, then the status
buffer for that is shown.
-
@item
Otherwise the user is offered to initialize the selected directory
as a new repository. After creating the repository its status
@@ -2822,18 +2659,15 @@ value of 16 or greater) an arbitrary directory is read,
which is
then acted on as described above. The same could be accomplished
using the command @code{magit-init}.
-
@item
With a single prefix argument an existing repository is read from
the user, or if no repository can be found based on the value of
@code{magit-repository-directories}, then the behavior is the same as with
two prefix arguments.
@end itemize
-
@end table
@defopt magit-repository-directories
-
List of directories that are Git repositories or contain Git
repositories.
@@ -2847,9 +2681,7 @@ This option controls which repositories are being listed
by
in potentially surprising ways (see above).
@end defopt
-@cindex magit-status-quick
@deffn Command magit-status-quick
-
This command is an alternative to @code{magit-status} that usually avoids
refreshing the status buffer.
@@ -2877,9 +2709,7 @@ It supports displaying any existing Magit buffer that
belongs to the
current repository; not just the status buffer.
@end deffn
-@cindex ido-enter-magit-status
@deffn Command ido-enter-magit-status
-
From an Ido prompt used to open a file, instead drop into
@code{magit-status}. This is similar to @code{ido-magic-delete-char}, which,
despite its name, usually causes a Dired buffer to be created.
@@ -2918,7 +2748,6 @@ The contents of status buffers is controlled using the
hook
hooks and how to customize them.
@defopt magit-status-sections-hook
-
Hook run to insert sections into a status buffer.
@end defopt
@@ -2927,46 +2756,38 @@ The first function on that hook by default is
By default the following functions are also members of that hook:
@defun magit-insert-merge-log
-
Insert section for the on-going merge. Display the heads that are
being merged. If no merge is in progress, do nothing.
@end defun
@defun magit-insert-rebase-sequence
-
Insert section for the on-going rebase sequence.
If no such sequence is in progress, do nothing.
@end defun
@defun magit-insert-am-sequence
-
Insert section for the on-going patch applying sequence.
If no such sequence is in progress, do nothing.
@end defun
@defun magit-insert-sequencer-sequence
-
Insert section for the on-going cherry-pick or revert sequence.
If no such sequence is in progress, do nothing.
@end defun
@defun magit-insert-bisect-output
-
While bisecting, insert section with output from @code{git bisect}.
@end defun
@defun magit-insert-bisect-rest
-
While bisecting, insert section visualizing the bisect state.
@end defun
@defun magit-insert-bisect-log
-
While bisecting, insert section logging bisect progress.
@end defun
@defun magit-insert-untracked-files
-
Maybe insert a list or tree of untracked files.
Do so depending on the value of @code{status.showUntrackedFiles}. Note
@@ -2976,17 +2797,14 @@ directories. But the directory sections can then be
expanded using
@end defun
@defun magit-insert-unstaged-changes
-
Insert section showing unstaged changes.
@end defun
@defun magit-insert-staged-changes
-
Insert section showing staged changes.
@end defun
@defun magit-insert-stashes &optional ref heading
-
Insert the @code{stashes} section showing reflog for "refs/stash".
If optional REF is non-nil show reflog for that instead.
If optional HEADING is non-nil use that as section heading
@@ -2994,25 +2812,21 @@ instead of "Stashes:".
@end defun
@defun magit-insert-unpulled-from-upstream
-
Insert section showing commits that haven't been pulled from the
upstream branch yet.
@end defun
@defun magit-insert-unpulled-from-pushremote
-
Insert section showing commits that haven't been pulled from the
push-remote branch yet.
@end defun
@defun magit-insert-unpushed-to-upstream
-
Insert section showing commits that haven't been pushed to the
upstream yet.
@end defun
@defun magit-insert-unpushed-to-pushremote
-
Insert section showing commits that haven't been pushed to the
push-remote yet.
@end defun
@@ -3020,12 +2834,10 @@ push-remote yet.
The following functions can also be added to the above hook:
@defun magit-insert-tracked-files
-
Insert a tree of tracked files.
@end defun
@defun magit-insert-ignored-files
-
Insert a tree of ignored files.
Its possible to limit the logs in the current buffer to a certain
directory using @code{D = f <DIRECTORY> RET g}. If you do that, then that
@@ -3037,7 +2849,6 @@ a directory.
@end defun
@defun magit-insert-skip-worktree-files
-
Insert a tree of skip-worktree files.
If the first element of @code{magit-buffer-diff-files} is a
directory, then limit the list to files below that. The value
@@ -3045,7 +2856,6 @@ of that variable can be set using @code{D -- DIRECTORY
RET g}.
@end defun
@defun magit-insert-assumed-unchanged-files
-
Insert a tree of files that are assumed to be unchanged.
If the first element of @code{magit-buffer-diff-files} is a
directory, then limit the list to files below that. The value
@@ -3053,7 +2863,6 @@ of that variable can be set using @code{D -- DIRECTORY
RET g}.
@end defun
@defun magit-insert-unpulled-or-recent-commits
-
Insert section showing unpulled or recent commits.
If an upstream is configured for the current branch and it is
ahead of the current branch, then show the missing commits.
@@ -3062,20 +2871,17 @@ commits.
@end defun
@defun magit-insert-recent-commits
-
Insert section showing the last @code{magit-log-section-commit-count}
commits.
@end defun
@defopt magit-log-section-commit-count
-
How many recent commits @code{magit-insert-recent-commits} and
@code{magit-insert-unpulled-or-recent-commits} (provided there are no
unpulled commits) show.
@end defopt
@defun magit-insert-unpulled-cherries
-
Insert section showing unpulled commits.
Like @code{magit-insert-unpulled-commits} but prefix each commit
that has not been applied yet (i.e. a commit with a patch-id
@@ -3084,7 +2890,6 @@ with "-".
@end defun
@defun magit-insert-unpushed-cherries
-
Insert section showing unpushed commits.
Like @code{magit-insert-unpushed-commits} but prefix each commit
which has not been applied to upstream yet (i.e. a commit with
@@ -3105,14 +2910,12 @@ By default @code{magit-insert-status-headers} is the
first member of that
hook variable.
@defun magit-insert-status-headers
-
Insert headers sections appropriate for @code{magit-status-mode} buffers.
The sections are inserted by running the functions on the hook
@code{magit-status-headers-hook}.
@end defun
@defopt magit-status-headers-hook
-
Hook run to insert headers sections into the status buffer.
This hook is run by @code{magit-insert-status-headers}, which in turn has
@@ -3122,7 +2925,6 @@ to be a member of @code{magit-status-sections-hook} to be
used at all.
By default the following functions are members of the above hook:
@defun magit-insert-error-header
-
Insert a header line showing the message about the Git error that
just occurred.
@@ -3133,29 +2935,24 @@ the status buffer causes this section to disappear
again.
@end defun
@defun magit-insert-diff-filter-header
-
Insert a header line showing the effective diff filters.
@end defun
@defun magit-insert-head-branch-header
-
Insert a header line about the current branch or detached @code{HEAD}.
@end defun
@defun magit-insert-upstream-branch-header
-
Insert a header line about the branch that is usually pulled into
the current branch.
@end defun
@defun magit-insert-push-branch-header
-
Insert a header line about the branch that the current branch is
usually pushed to.
@end defun
@defun magit-insert-tags-header
-
Insert a header line about the current and/or next tag, along with
the number of commits between the tag and @code{HEAD}.
@end defun
@@ -3163,12 +2960,10 @@ the number of commits between the tag and @code{HEAD}.
The following functions can also be added to the above hook:
@defun magit-insert-repo-header
-
Insert a header line showing the path to the repository top-level.
@end defun
@defun magit-insert-remote-header
-
Insert a header line about the remote of the current branch.
If no remote is configured for the current branch, then fall back
@@ -3177,7 +2972,6 @@ remote in alphabetic order.
@end defun
@defun magit-insert-user-header
-
Insert a header line about the current user.
@end defun
@@ -3191,7 +2985,6 @@ By default @code{magit-insert-modules} is @emph{not} a
member of that hook
variable.
@defun magit-insert-modules
-
Insert submodule sections.
Hook @code{magit-module-sections-hook} controls which module sections are
@@ -3200,12 +2993,10 @@ they are wrapped in an additional section.
@end defun
@defopt magit-module-sections-hook
-
Hook run by @code{magit-insert-modules}.
@end defopt
@defopt magit-module-sections-nested
-
This option controls whether @code{magit-insert-modules} wraps inserted
sections in an additional section.
@@ -3215,7 +3006,6 @@ become top-level sections.
@end defopt
@defun magit-insert-modules-overview
-
Insert sections for all submodules. For each section insert the
path, the branch, and the output of @code{git describe --tags},
or, failing that, the abbreviated HEAD commit hash.
@@ -3227,27 +3017,23 @@ displayed in the super-repository's status buffer.
@end defun
@defun magit-insert-modules-unpulled-from-upstream
-
Insert sections for modules that haven't been pulled from the
upstream yet. These sections can be expanded to show the respective
commits.
@end defun
@defun magit-insert-modules-unpulled-from-pushremote
-
Insert sections for modules that haven't been pulled from the
push-remote yet. These sections can be expanded to show the
respective commits.
@end defun
@defun magit-insert-modules-unpushed-to-upstream
-
Insert sections for modules that haven't been pushed to the upstream
yet. These sections can be expanded to show the respective commits.
@end defun
@defun magit-insert-modules-unpushed-to-pushremote
-
Insert sections for modules that haven't been pushed to the
push-remote yet. These sections can be expanded to show the
respective commits.
@@ -3257,12 +3043,10 @@ respective commits.
@subsection Status Options
@defopt magit-status-refresh-hook
-
Hook run after a status buffer has been refreshed.
@end defopt
@defopt magit-status-margin
-
This option specifies whether the margin is initially shown in
Magit-Status mode buffers and how it is formatted.
@@ -3271,7 +3055,6 @@ The value has the form @code{(INIT STYLE WIDTH AUTHOR
AUTHOR-WIDTH)}.
@itemize
@item
If INIT is non-nil, then the margin is shown initially.
-
@item
STYLE controls how to format the author or committer date. It can
be one of @code{age} (to show the age of the commit), @code{age-abbreviated}
(to
@@ -3279,15 +3062,12 @@ abbreviate the time unit to a character), or a string
(suitable
for @code{format-time-string}) to show the actual date. Option
@code{magit-log-margin-show-committer-date} controls which date is being
displayed.
-
@item
WIDTH controls the width of the margin. This exists for forward
compatibility and currently the value should not be changed.
-
@item
AUTHOR controls whether the name of the author is also shown by
default.
-
@item
AUTHOR-WIDTH has to be an integer. When the name of the author
is shown, then this specifies how much space is used to do so.
@@ -3300,9 +3080,7 @@ buffers.
@node Repository List
@section Repository List
-@cindex magit-list-repositories
@deffn Command magit-list-repositories
-
This command displays a list of repositories in a separate buffer.
The options @code{magit-repository-directories} and
@@ -3311,7 +3089,6 @@ displayed.
@end deffn
@defopt magit-repolist-columns
-
This option controls what columns are displayed by the command
@code{magit-list-repositories} and how they are displayed.
@@ -3334,44 +3111,36 @@ than 9.
The following functions can be added to the above option:
@defun magit-repolist-column-ident
-
This function inserts the identification of the repository. Usually
this is just its basename.
@end defun
@defun magit-repolist-column-path
-
This function inserts the absolute path of the repository.
@end defun
@defun magit-repolist-column-version
-
This function inserts a description of the repository's @code{HEAD} revision.
@end defun
@defun magit-repolist-column-branch
-
This function inserts the name of the current branch.
@end defun
@defun magit-repolist-column-upstream
-
This function inserts the name of the upstream branch of the current
branch.
@end defun
@defun magit-repolist-column-branches
-
This function inserts the number of branches.
@end defun
@defun magit-repolist-column-stashes
-
This function inserts the number of stashes.
@end defun
@defun magit-repolist-column-flag
-
This function inserts a flag as specified by
@code{magit-repolist-column-flag-alist}.
@@ -3380,10 +3149,8 @@ By default this indicates whether there are uncommitted
changes.
@itemize
@item
@code{N} if there is at least one untracked file.
-
@item
@code{U} if there is at least one unstaged file.
-
@item
@code{S} if there is at least one staged file.
@end itemize
@@ -3392,25 +3159,21 @@ Only the first one of these that applies is shown.
@end defun
@defun magit-repolist-column-unpulled-from-upstream
-
This function inserts the number of upstream commits not in the
current branch.
@end defun
@defun magit-repolist-column-unpulled-from-pushremote
-
This function inserts the number of commits in the push branch but
not the current branch.
@end defun
@defun magit-repolist-column-unpushed-to-upstream
-
This function inserts the number of commits in the current branch
but not its upstream.
@end defun
@defun magit-repolist-column-unpushed-to-pushremote
-
This function inserts the number of commits in the current branch
but not its push branch.
@end defun
@@ -3449,53 +3212,46 @@ The switch @code{++order=VALUE} is converted to one of
@code{--author-date-order
The log transient also features several reflog commands. See @ref{Reflog}.
@table @asis
+@item @kbd{l} (@code{magit-log})
@kindex l
-@cindex magit-log
-@item @kbd{l} @tie{}@tie{}@tie{}@tie{}(@code{magit-log})
-
+@findex magit-log
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
+@item @kbd{l l} (@code{magit-log-current})
@kindex l l
-@cindex magit-log-current
-@item @kbd{l l} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-current})
-
+@findex magit-log-current
Show log for the current branch. When @code{HEAD} is detached or with a
prefix argument, show log for one or more revs read from the
minibuffer.
+@item @kbd{l o} (@code{magit-log-other})
@kindex l o
-@cindex magit-log-other
-@item @kbd{l o} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-other})
-
+@findex magit-log-other
Show log for one or more revs read from the minibuffer. The user
can input any revision or revisions separated by a space, or even
ranges, but only branches, tags, and a representation of the
commit at point are available as completion candidates.
+@item @kbd{l h} (@code{magit-log-head})
@kindex l h
-@cindex magit-log-head
-@item @kbd{l h} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-head})
-
+@findex magit-log-head
Show log for @code{HEAD}.
+@item @kbd{l L} (@code{magit-log-branches})
@kindex l L
-@cindex magit-log-branches
-@item @kbd{l L} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-branches})
-
+@findex magit-log-branches
Show log for all local branches and @code{HEAD}.
+@item @kbd{l b} (@code{magit-log-all-branches})
@kindex l b
-@cindex magit-log-all-branches
-@item @kbd{l b} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-all-branches})
-
+@findex magit-log-all-branches
Show log for all local and remote branches and @code{HEAD}.
+@item @kbd{l a} (@code{magit-log-all})
@kindex l a
-@cindex magit-log-all
-@item @kbd{l a} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-all})
-
+@findex magit-log-all
Show log for all references and @code{HEAD}.
@end table
@@ -3521,43 +3277,38 @@ which log is shown. This works in dedicated log
buffers, but also in
the status buffer.
@table @asis
+@item @kbd{L} (@code{magit-log-refresh})
@kindex L
-@cindex magit-log-refresh
-@item @kbd{L} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-refresh})
-
+@findex magit-log-refresh
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
+@item @kbd{L g} (@code{magit-log-refresh})
@kindex L g
-@cindex magit-log-refresh
-@item @kbd{L g} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-refresh})
-
+@findex magit-log-refresh
This suffix command sets the local log arguments for the current
buffer.
+@item @kbd{L s} (@code{magit-log-set-default-arguments})
@kindex L s
-@cindex magit-log-set-default-arguments
-@item @kbd{L s}
@tie{}@tie{}@tie{}@tie{}(@code{magit-log-set-default-arguments})
-
+@findex magit-log-set-default-arguments
This suffix command sets the default log arguments for buffers of
the same type as that of the current buffer. Other existing buffers
of the same type are not affected because their local values have
already been initialized.
+@item @kbd{L w} (@code{magit-log-save-default-arguments})
@kindex L w
-@cindex magit-log-save-default-arguments
-@item @kbd{L w}
@tie{}@tie{}@tie{}@tie{}(@code{magit-log-save-default-arguments})
-
+@findex magit-log-save-default-arguments
This suffix command sets the default log arguments for buffers of
the same type as that of the current buffer, and saves the value for
future sessions. Other existing buffers of the same type are not
affected because their local values have already been initialized.
+@item @kbd{L t} (@code{magit-toggle-margin})
@kindex L t
-@cindex magit-toggle-margin
-@item @kbd{L t} @tie{}@tie{}@tie{}@tie{}(@code{magit-toggle-margin})
-
+@findex magit-toggle-margin
Show or hide the margin.
@end table
@@ -3565,49 +3316,43 @@ Show or hide the margin.
@subsection Log Buffer
@table @asis
+@item @kbd{L} (@code{magit-log-refresh})
@kindex L
-@cindex magit-log-refresh
-@item @kbd{L} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-refresh})
-
+@findex magit-log-refresh
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
See @ref{Refreshing Logs}.
+@item @kbd{q} (@code{magit-log-bury-buffer})
@kindex q
-@cindex magit-log-bury-buffer
-@item @kbd{q} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-bury-buffer})
-
+@findex magit-log-bury-buffer
Bury the current buffer or the revision buffer in the same frame.
Like @code{magit-mode-bury-buffer} (which see) but with a negative prefix
argument instead bury the revision buffer, provided it is displayed
in the current frame.
+@item @kbd{C-c C-b} (@code{magit-go-backward})
@kindex C-c C-b
-@cindex magit-go-backward
-@item @kbd{C-c C-b} @tie{}@tie{}@tie{}@tie{}(@code{magit-go-backward})
-
+@findex magit-go-backward
Move backward in current buffer's history.
+@item @kbd{C-c C-f} (@code{magit-go-forward})
@kindex C-c C-f
-@cindex magit-go-forward
-@item @kbd{C-c C-f} @tie{}@tie{}@tie{}@tie{}(@code{magit-go-forward})
-
+@findex magit-go-forward
Move forward in current buffer's history.
+@item @kbd{C-c C-n} (@code{magit-log-move-to-parent})
@kindex C-c C-n
-@cindex magit-log-move-to-parent
-@item @kbd{C-c C-n} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-move-to-parent})
-
+@findex magit-log-move-to-parent
Move to a parent of the current commit. By default, this is the
first parent, but a numeric prefix can be used to specify another
parent.
+@item @kbd{j} (@code{magit-log-move-to-revision})
@kindex j
-@cindex magit-log-move-to-revision
-@item @kbd{j} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-move-to-revision})
-
+@findex magit-log-move-to-revision
Read a revision and move to it in current log buffer.
If the chosen reference or revision isn't being displayed in
@@ -3617,10 +3362,9 @@ nothing else.
If invoked outside any log buffer, then display the log buffer
of the current repository first; creating it if necessary.
+@item @kbd{@key{SPC}} (@code{magit-diff-show-or-scroll-up})
@kindex SPC
-@cindex magit-diff-show-or-scroll-up
-@item @kbd{SPC} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-show-or-scroll-up})
-
+@findex magit-diff-show-or-scroll-up
Update the commit or diff buffer for the thing at point.
Either show the commit or stash at point in the appropriate buffer,
@@ -3629,10 +3373,9 @@ and contains information about that commit or stash,
then instead
scroll the buffer up. If there is no commit or stash at point, then
prompt for a commit.
+@item @kbd{DEL} (@code{magit-diff-show-or-scroll-down})
@kindex DEL
-@cindex magit-diff-show-or-scroll-down
-@item @kbd{DEL} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-show-or-scroll-down})
-
+@findex magit-diff-show-or-scroll-down
Update the commit or diff buffer for the thing at point.
Either show the commit or stash at point in the appropriate buffer,
@@ -3641,37 +3384,31 @@ and contains information about that commit or stash,
then instead
scroll the buffer down. If there is no commit or stash at point,
then prompt for a commit.
+@item @kbd{=} (@code{magit-log-toggle-commit-limit})
@kindex =
-@cindex magit-log-toggle-commit-limit
-@item @kbd{=} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-toggle-commit-limit})
-
+@findex magit-log-toggle-commit-limit
Toggle the number of commits the current log buffer is limited to.
If the number of commits is currently limited, then remove that
limit. Otherwise set it to 256.
+@item @kbd{+} (@code{magit-log-double-commit-limit})
@kindex +
-@cindex magit-log-double-commit-limit
-@item @kbd{+} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-double-commit-limit})
-
+@findex magit-log-double-commit-limit
Double the number of commits the current log buffer is limited to.
+@item @kbd{-} (@code{magit-log-half-commit-limit})
@kindex -
-@cindex magit-log-half-commit-limit
-@item @kbd{-} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-half-commit-limit})
-
+@findex magit-log-half-commit-limit
Half the number of commits the current log buffer is limited to.
-
@end table
@defopt magit-log-auto-more
-
Insert more log entries automatically when moving past the last
entry. Only considered when moving past the last entry with
@code{magit-goto-*-section} commands.
@end defopt
@defopt magit-log-show-refname-after-summary
-
Whether to show the refnames after the commit summaries. This is
useful if you use really long branch names.
@end defopt
@@ -3716,7 +3453,6 @@ is the same as in the respective major-mode
@code{magit-INFIX-mode}. In
regular log buffers that would be @code{magit-log-margin}.
@defopt magit-log-margin
-
This option specifies whether the margin is initially shown in
Magit-Log mode buffers and how it is formatted.
@@ -3725,7 +3461,6 @@ The value has the form @code{(INIT STYLE WIDTH AUTHOR
AUTHOR-WIDTH)}.
@itemize
@item
If INIT is non-nil, then the margin is shown initially.
-
@item
STYLE controls how to format the author or committer date. It can
be one of @code{age} (to show the age of the commit), @code{age-abbreviated}
(to
@@ -3733,15 +3468,12 @@ abbreviate the time unit to a character), or a string
(suitable
for @code{format-time-string}) to show the actual date. Option
@code{magit-log-margin-show-committer-date} controls which date is being
displayed.
-
@item
WIDTH controls the width of the margin. This exists for forward
compatibility and currently the value should not be changed.
-
@item
AUTHOR controls whether the name of the author is also shown by
default.
-
@item
AUTHOR-WIDTH has to be an integer. When the name of the author
is shown, then this specifies how much space is used to do so.
@@ -3758,7 +3490,6 @@ re-enforcing the default for that option, does not carry
to other
options.
@defopt magit-log-margin-show-committer-date
-
This option specifies whether to show the committer date in the
margin. This option only controls whether the committer date is
displayed instead of the author date. Whether some date is
@@ -3767,10 +3498,9 @@ is controlled by other options.
@end defopt
@table @asis
+@item @kbd{L} (@code{magit-margin-settings})
@kindex L
-@cindex magit-margin-settings
-@item @kbd{L} @tie{}@tie{}@tie{}@tie{}(@code{magit-margin-settings})
-
+@findex magit-margin-settings
This transient prefix command binds the following suffix commands,
each of which changes the appearance of the margin in some way.
@end table
@@ -3780,22 +3510,19 @@ In some buffers that support the margin, @code{L} is
instead bound to
then some other unrelated commands.
@table @asis
+@item @kbd{L L} (@code{magit-toggle-margin})
@kindex L L
-@cindex magit-toggle-margin
-@item @kbd{L L} @tie{}@tie{}@tie{}@tie{}(@code{magit-toggle-margin})
-
+@findex magit-toggle-margin
This command shows or hides the margin.
+@item @kbd{L l} (@code{magit-cycle-margin-style})
@kindex L l
-@cindex magit-cycle-margin-style
-@item @kbd{L l} @tie{}@tie{}@tie{}@tie{}(@code{magit-cycle-margin-style})
-
+@findex magit-cycle-margin-style
This command cycles the style used for the margin.
+@item @kbd{L d} (@code{magit-toggle-margin-details})
@kindex L d
-@cindex magit-toggle-margin-details
-@item @kbd{L d} @tie{}@tie{}@tie{}@tie{}(@code{magit-toggle-margin-details})
-
+@findex magit-toggle-margin-details
This command shows or hides details in the margin.
@end table
@@ -3817,24 +3544,20 @@ following additional key bindings are available in
selection log
buffers:
@table @asis
+@item @kbd{C-c C-c} (@code{magit-log-select-pick})
@kindex C-c C-c
-@cindex magit-log-select-pick
-@item @kbd{C-c C-c} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-select-pick})
-
+@findex magit-log-select-pick
Select the commit at point and act on it. Call
@code{magit-log-select-pick-function} with the selected commit as
argument.
+@item @kbd{C-c C-k} (@code{magit-log-select-quit})
@kindex C-c C-k
-@cindex magit-log-select-quit
-@item @kbd{C-c C-k} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-select-quit})
-
+@findex magit-log-select-quit
Abort selecting a commit, don't act on any commit.
-
@end table
@defopt magit-log-select-margin
-
This option specifies whether the margin is initially shown in
Magit-Log-Select mode buffers and how it is formatted.
@@ -3843,7 +3566,6 @@ The value has the form @code{(INIT STYLE WIDTH AUTHOR
AUTHOR-WIDTH)}.
@itemize
@item
If INIT is non-nil, then the margin is shown initially.
-
@item
STYLE controls how to format the author or committer date. It can
be one of @code{age} (to show the age of the commit), @code{age-abbreviated}
(to
@@ -3851,15 +3573,12 @@ abbreviate the time unit to a character), or a string
(suitable
for @code{format-time-string}) to show the actual date. Option
@code{magit-log-margin-show-committer-date} controls which date is being
displayed.
-
@item
WIDTH controls the width of the margin. This exists for forward
compatibility and currently the value should not be changed.
-
@item
AUTHOR controls whether the name of the author is also shown by
default.
-
@item
AUTHOR-WIDTH has to be an integer. When the name of the author
is shown, then this specifies how much space is used to do so.
@@ -3886,28 +3605,23 @@ These reflog commands are available from the log
transient. See
@ref{Logging}.
@table @asis
+@item @kbd{l r} (@code{magit-reflog-current})
@kindex l r
-@cindex magit-reflog-current
-@item @kbd{l r} @tie{}@tie{}@tie{}@tie{}(@code{magit-reflog-current})
-
+@findex magit-reflog-current
Display the reflog of the current branch.
+@item @kbd{l O} (@code{magit-reflog-other})
@kindex l O
-@cindex magit-reflog-other
-@item @kbd{l O} @tie{}@tie{}@tie{}@tie{}(@code{magit-reflog-other})
-
+@findex magit-reflog-other
Display the reflog of a branch or another ref.
+@item @kbd{l H} (@code{magit-reflog-head})
@kindex l H
-@cindex magit-reflog-head
-@item @kbd{l H} @tie{}@tie{}@tie{}@tie{}(@code{magit-reflog-head})
-
+@findex magit-reflog-head
Display the @code{HEAD} reflog.
-
@end table
@defopt magit-reflog-margin
-
This option specifies whether the margin is initially shown in
Magit-Reflog mode buffers and how it is formatted.
@@ -3916,7 +3630,6 @@ The value has the form @code{(INIT STYLE WIDTH AUTHOR
AUTHOR-WIDTH)}.
@itemize
@item
If INIT is non-nil, then the margin is shown initially.
-
@item
STYLE controls how to format the author or committer date. It can
be one of @code{age} (to show the age of the commit), @code{age-abbreviated}
(to
@@ -3924,15 +3637,12 @@ abbreviate the time unit to a character), or a string
(suitable
for @code{format-time-string}) to show the actual date. Option
@code{magit-log-margin-show-committer-date} controls which date is being
displayed.
-
@item
WIDTH controls the width of the margin. This exists for forward
compatibility and currently the value should not be changed.
-
@item
AUTHOR controls whether the name of the author is also shown by
default.
-
@item
AUTHOR-WIDTH has to be an integer. When the name of the author
is shown, then this specifies how much space is used to do so.
@@ -3965,17 +3675,14 @@ the git-reflog(1) manpage.
@end iftex
@table @asis
+@item @kbd{Y} (@code{magit-cherry})
@kindex Y
-@cindex magit-cherry
-@item @kbd{Y} @tie{}@tie{}@tie{}@tie{}(@code{magit-cherry})
-
+@findex magit-cherry
Show commits that are in a certain branch but that have not been
merged in the upstream branch.
-
@end table
@defopt magit-cherry-margin
-
This option specifies whether the margin is initially shown in
Magit-Cherry mode buffers and how it is formatted.
@@ -3984,7 +3691,6 @@ The value has the form @code{(INIT STYLE WIDTH AUTHOR
AUTHOR-WIDTH)}.
@itemize
@item
If INIT is non-nil, then the margin is shown initially.
-
@item
STYLE controls how to format the author or committer date. It can
be one of @code{age} (to show the age of the commit), @code{age-abbreviated}
(to
@@ -3992,15 +3698,12 @@ abbreviate the time unit to a character), or a string
(suitable
for @code{format-time-string}) to show the actual date. Option
@code{magit-log-margin-show-committer-date} controls which date is being
displayed.
-
@item
WIDTH controls the width of the margin. This exists for forward
compatibility and currently the value should not be changed.
-
@item
AUTHOR controls whether the name of the author is also shown by
default.
-
@item
AUTHOR-WIDTH has to be an integer. When the name of the author
is shown, then this specifies how much space is used to do so.
@@ -4036,24 +3739,21 @@ the git-diff(1) manpage.
@end iftex
@table @asis
+@item @kbd{d} (@code{magit-diff})
@kindex d
-@cindex magit-diff
-@item @kbd{d} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff})
-
+@findex magit-diff
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
+@item @kbd{d d} (@code{magit-diff-dwim})
@kindex d d
-@cindex magit-diff-dwim
-@item @kbd{d d} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-dwim})
-
+@findex magit-diff-dwim
Show changes for the thing at point.
+@item @kbd{d r} (@code{magit-diff-range})
@kindex d r
-@cindex magit-diff-range
-@item @kbd{d r} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-range})
-
+@findex magit-diff-range
Show differences between two commits.
RANGE should be a range (A..B or A@dots{}B) but can also be a single
@@ -4066,32 +3766,28 @@ line of the region. With a prefix argument, instead of
diffing the
revisions, choose a revision to view changes along, starting at the
common ancestor of both revisions (i.e., use a "@dots{}" range).
+@item @kbd{d w} (@code{magit-diff-working-tree})
@kindex d w
-@cindex magit-diff-working-tree
-@item @kbd{d w} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-working-tree})
-
+@findex magit-diff-working-tree
Show changes between the current working tree and the @code{HEAD} commit.
With a prefix argument show changes between the working tree and a
commit read from the minibuffer.
+@item @kbd{d s} (@code{magit-diff-staged})
@kindex d s
-@cindex magit-diff-staged
-@item @kbd{d s} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-staged})
-
+@findex magit-diff-staged
Show changes between the index and the @code{HEAD} commit. With a prefix
argument show changes between the index and a commit read from the
minibuffer.
+@item @kbd{d u} (@code{magit-diff-unstaged})
@kindex d u
-@cindex magit-diff-unstaged
-@item @kbd{d u} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-unstaged})
-
+@findex magit-diff-unstaged
Show changes between the working tree and the index.
+@item @kbd{d p} (@code{magit-diff-paths})
@kindex d p
-@cindex magit-diff-paths
-@item @kbd{d p} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-paths})
-
+@findex magit-diff-paths
Show changes between any two files on disk.
@end table
@@ -4100,17 +3796,15 @@ The diff transient also features two commands which
show differences
in another buffer:
@table @asis
+@item @kbd{d c} (@code{magit-show-commit})
@kindex d c
-@cindex magit-show-commit
-@item @kbd{d c} @tie{}@tie{}@tie{}@tie{}(@code{magit-show-commit})
-
+@findex magit-show-commit
Show the commit at point. If there is no commit at point or with a
prefix argument, prompt for a commit.
+@item @kbd{d t} (@code{magit-stash-show})
@kindex d t
-@cindex magit-stash-show
-@item @kbd{d t} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-show})
-
+@findex magit-stash-show
Show all diffs of a stash in a buffer.
@end table
@@ -4133,63 +3827,55 @@ which diff is shown. This works in dedicated diff
buffers, but also
in the status buffer.
@table @asis
+@item @kbd{D} (@code{magit-diff-refresh})
@kindex D
-@cindex magit-diff-refresh
-@item @kbd{D} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-refresh})
-
+@findex magit-diff-refresh
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
+@item @kbd{D g} (@code{magit-diff-refresh})
@kindex D g
-@cindex magit-diff-refresh
-@item @kbd{D g} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-refresh})
-
+@findex magit-diff-refresh
This suffix command sets the local diff arguments for the current
buffer.
+@item @kbd{D s} (@code{magit-diff-set-default-arguments})
@kindex D s
-@cindex magit-diff-set-default-arguments
-@item @kbd{D s}
@tie{}@tie{}@tie{}@tie{}(@code{magit-diff-set-default-arguments})
-
+@findex magit-diff-set-default-arguments
This suffix command sets the default diff arguments for buffers of
the same type as that of the current buffer. Other existing buffers
of the same type are not affected because their local values have
already been initialized.
+@item @kbd{D w} (@code{magit-diff-save-default-arguments})
@kindex D w
-@cindex magit-diff-save-default-arguments
-@item @kbd{D w}
@tie{}@tie{}@tie{}@tie{}(@code{magit-diff-save-default-arguments})
-
+@findex magit-diff-save-default-arguments
This suffix command sets the default diff arguments for buffers of
the same type as that of the current buffer, and saves the value for
future sessions. Other existing buffers of the same type are not
affected because their local values have already been initialized.
+@item @kbd{D t} (@code{magit-diff-toggle-refine-hunk})
@kindex D t
-@cindex magit-diff-toggle-refine-hunk
-@item @kbd{D t} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-toggle-refine-hunk})
-
+@findex magit-diff-toggle-refine-hunk
This command toggles hunk refinement on or off.
+@item @kbd{D r} (@code{magit-diff-switch-range-type})
@kindex D r
-@cindex magit-diff-switch-range-type
-@item @kbd{D r} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-switch-range-type})
-
+@findex magit-diff-switch-range-type
This command converts the diff range type from "revA..revB" to
"revB@dots{}revA", or vice versa.
+@item @kbd{D f} (@code{magit-diff-flip-revs})
@kindex D f
-@cindex magit-diff-flip-revs
-@item @kbd{D f} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-flip-revs})
-
+@findex magit-diff-flip-revs
This command swaps revisions in the diff range from "revA..revB"
to "revB..revA", or vice versa.
+@item @kbd{D F} (@code{magit-diff-toggle-file-filter})
@kindex D F
-@cindex magit-diff-toggle-file-filter
-@item @kbd{D F} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-toggle-file-filter})
-
+@findex magit-diff-toggle-file-filter
This command toggles the file restriction of the diffs in the
current buffer, allowing you to quickly switch between viewing all
the changes in the commit and the restricted subset. As a special
@@ -4204,22 +3890,19 @@ supported arguments, there also exist some commands
that change only
a particular argument.
@table @asis
+@item @kbd{-} (@code{magit-diff-less-context})
@kindex -
-@cindex magit-diff-less-context
-@item @kbd{-} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-less-context})
-
+@findex magit-diff-less-context
This command decreases the context for diff hunks by COUNT lines.
+@item @kbd{+} (@code{magit-diff-more-context})
@kindex +
-@cindex magit-diff-more-context
-@item @kbd{+} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-more-context})
-
+@findex magit-diff-more-context
This command increases the context for diff hunks by COUNT lines.
+@item @kbd{0} (@code{magit-diff-default-context})
@kindex 0
-@cindex magit-diff-default-context
-@item @kbd{0} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-default-context})
-
+@findex magit-diff-default-context
This command resets the context for diff hunks to the default height.
@end table
@@ -4227,10 +3910,9 @@ The following commands quickly change what diff is being
displayed
without having to using one of the diff transient.
@table @asis
+@item @kbd{C-c C-d} (@code{magit-diff-while-committing})
@kindex C-c C-d
-@cindex magit-diff-while-committing
-@item @kbd{C-c C-d}
@tie{}@tie{}@tie{}@tie{}(@code{magit-diff-while-committing})
-
+@findex magit-diff-while-committing
While committing, this command shows the changes that are about to
be committed. While amending, invoking the command again toggles
between showing just the new changes or all the changes that will be
@@ -4239,16 +3921,14 @@ committed.
This binding is available in the diff buffer as well as the commit
message buffer.
+@item @kbd{C-c C-b} (@code{magit-go-backward})
@kindex C-c C-b
-@cindex magit-go-backward
-@item @kbd{C-c C-b} @tie{}@tie{}@tie{}@tie{}(@code{magit-go-backward})
-
+@findex magit-go-backward
This command moves backward in current buffer's history.
+@item @kbd{C-c C-f} (@code{magit-go-forward})
@kindex C-c C-f
-@cindex magit-go-forward
-@item @kbd{C-c C-f} @tie{}@tie{}@tie{}@tie{}(@code{magit-go-forward})
-
+@findex magit-go-forward
This command moves forward in current buffer's history.
@end table
@@ -4263,16 +3943,13 @@ version of the file that the diff at point is about.
Likewise
version of the file that the diff at point is about. See @ref{Visiting Files
and Blobs from a Diff} for more information and the key bindings.
@table @asis
+@item @kbd{C-c C-t} (@code{magit-diff-trace-definition})
@kindex C-c C-t
-@cindex magit-diff-trace-definition
-@item @kbd{C-c C-t}
@tie{}@tie{}@tie{}@tie{}(@code{magit-diff-trace-definition})
-
+@findex magit-diff-trace-definition
This command shows a log for the definition at point.
-
@end table
@defopt magit-log-trace-definition-function
-
The function specified by this option is used by
@code{magit-log-trace-definition} to determine the function at point. For
major-modes that have special needs, you could set the local value
@@ -4280,10 +3957,9 @@ using the mode's hook.
@end defopt
@table @asis
+@item @kbd{C-c C-e} (@code{magit-diff-edit-hunk-commit})
@kindex C-c C-e
-@cindex magit-diff-edit-hunk-commit
-@item @kbd{C-c C-e}
@tie{}@tie{}@tie{}@tie{}(@code{magit-diff-edit-hunk-commit})
-
+@findex magit-diff-edit-hunk-commit
From a hunk, this command edits the respective commit and visits
the file.
@@ -4302,10 +3978,9 @@ Neither the blob nor the file buffer are killed when
finishing
the rebase. If that is undesirable, then it might be better to
use @code{magit-rebase-edit-command} instead of this command.
+@item @kbd{j} (@code{magit-jump-to-diffstat-or-diff})
@kindex j
-@cindex magit-jump-to-diffstat-or-diff
-@item @kbd{j} @tie{}@tie{}@tie{}@tie{}(@code{magit-jump-to-diffstat-or-diff})
-
+@findex magit-jump-to-diffstat-or-diff
This command jumps to the diffstat or diff. When point is on a file
inside the diffstat section, then jump to the respective diff
section. Otherwise, jump to the diffstat section or a child
@@ -4317,16 +3992,14 @@ Magit buffer for that matter), but it might be worth
pointing out
that they are available here too.
@table @asis
+@item @kbd{@key{SPC}} (@code{scroll-up})
@kindex SPC
-@cindex scroll-up
-@item @kbd{SPC} @tie{}@tie{}@tie{}@tie{}(@code{scroll-up})
-
+@findex scroll-up
This command scrolls text upward.
+@item @kbd{DEL} (@code{scroll-down})
@kindex DEL
-@cindex scroll-down
-@item @kbd{DEL} @tie{}@tie{}@tie{}@tie{}(@code{scroll-down})
-
+@findex scroll-down
This command scrolls text downward.
@end table
@@ -4334,29 +4007,24 @@ This command scrolls text downward.
@subsection Diff Options
@defopt magit-diff-refine-hunk
-
Whether to show word-granularity differences within diff hunks.
@itemize
@item
@code{nil} Never show fine differences.
-
@item
@code{t} Show fine differences for the current diff hunk only.
-
@item
@code{all} Show fine differences for all displayed diff hunks.
@end itemize
@end defopt
@defopt magit-diff-refine-ignore-whitespace
-
Whether to ignore whitespace changes in word-granularity
differences.
@end defopt
@defopt magit-diff-adjust-tab-width
-
Whether to adjust the width of tabs in diffs.
Determining the correct width can be expensive if it requires
@@ -4369,18 +4037,15 @@ the cache.
@code{nil} Never adjust tab width. Use `tab-width's value from the Magit
buffer itself instead.
-
@item
@code{t} If the corresponding file-visiting buffer exits, then use
@code{tab-width}'s value from that buffer. Doing this is cheap, so this
value is used even if a corresponding cache entry exists.
-
@item
@code{always} If there is no such buffer, then temporarily visit the file
to determine the value.
-
@item
NUMBER Like @code{always}, but don't visit files larger than NUMBER
bytes.
@@ -4388,7 +4053,6 @@ bytes.
@end defopt
@defopt magit-diff-paint-whitespace
-
Specify where to highlight whitespace errors.
See @code{magit-diff-highlight-trailing},
@@ -4399,10 +4063,8 @@ nowhere.
@itemize
@item
@code{nil} Never highlight whitespace errors.
-
@item
@code{t} Highlight whitespace errors everywhere.
-
@item
@code{uncommitted} Only highlight whitespace errors in diffs showing
uncommitted changes. For backward compatibility @code{status} is treated
@@ -4411,29 +4073,24 @@ as a synonym.
@end defopt
@defopt magit-diff-paint-whitespace-lines
-
Specify in what kind of lines to highlight whitespace errors.
@itemize
@item
@code{t} Highlight only in added lines.
-
@item
@code{both} Highlight in added and removed lines.
-
@item
@code{all} Highlight in added, removed and context lines.
@end itemize
@end defopt
@defopt magit-diff-highlight-trailing
-
Whether to highlight whitespace at the end of a line in diffs. Used
only when @code{magit-diff-paint-whitespace} is non-nil.
@end defopt
@defopt magit-diff-highlight-indentation
-
This option controls whether to highlight the indentation in case it
used the "wrong" indentation style. Indentation is only highlighted
if @code{magit-diff-paint-whitespace} is also non-nil.
@@ -4449,12 +4106,10 @@ spaces. Otherwise, highlight neither.
@end defopt
@defopt magit-diff-hide-trailing-cr-characters
-
Whether to hide ^M characters at the end of a line in diffs.
@end defopt
@defopt magit-diff-highlight-hunk-region-functions
-
This option specifies the functions used to highlight the
hunk-internal region.
@@ -4480,7 +4135,6 @@ calling the face function instead.
@end defopt
@defopt magit-diff-unmarked-lines-keep-foreground
-
This option controls whether added and removed lines outside the
hunk-internal region only lose their distinct background color or
also the foreground color. Whether the outside of the region is
@@ -4488,7 +4142,6 @@ dimmed at all depends on
@code{magit-diff-highlight-hunk-region-functions}.
@end defopt
@defopt magit-diff-extra-stat-arguments
-
This option specifies additional arguments to be used alongside
@code{--stat}.
@@ -4513,26 +4166,21 @@ the git-diff(1) manpage.
@subsection Revision Buffer
@defopt magit-revision-insert-related-refs
-
Whether to show related branches in revision buffers.
@itemize
@item
@code{nil} Don't show any related branches.
-
@item
@code{t} Show related local branches.
-
@item
@code{all} Show related local and remote branches.
-
@item
@code{mixed} Show all containing branches and local merged branches.
@end itemize
@end defopt
@defopt magit-revision-show-gravatars
-
Whether to show gravatar images in revision buffers.
If @code{nil}, then don't insert any gravatar images. If @code{t}, then insert
@@ -4550,7 +4198,6 @@ image, accordingly. Either the car or the cdr may be
nil."
@end defopt
@defopt magit-revision-use-hash-sections
-
Whether to turn hashes inside the commit message into sections.
If non-nil, then hashes inside the commit message are turned into
@@ -4560,13 +4207,10 @@ performance and reliability:
@itemize
@item
@code{slow} calls git for every word to be absolutely sure.
-
@item
@code{quick} skips words less than seven characters long.
-
@item
@code{quicker} additionally skips words that don't contain a number.
-
@item
@code{quickest} uses all words that are at least seven characters long
and which contain at least one number as well as at least one
@@ -4584,7 +4228,6 @@ restriction as that log buffer (also see the command
@code{magit-diff-toggle-file-filter}).
@defopt magit-revision-filter-files-on-follow
-
Whether showing a commit from a log buffer honors the log's file
filter when the log arguments include @code{--follow}.
@@ -4608,10 +4251,9 @@ This section describes how to enter Ediff from Magit
buffers. For
information on how to use Ediff itself, see @ref{Top,,,ediff,}.
@table @asis
+@item @kbd{e} (@code{magit-ediff-dwim})
@kindex e
-@cindex magit-ediff-dwim
-@item @kbd{e} @tie{}@tie{}@tie{}@tie{}(@code{magit-ediff-dwim})
-
+@findex magit-ediff-dwim
Compare, stage, or resolve using Ediff.
This command tries to guess what file, and what commit or range the
@@ -4622,17 +4264,15 @@ in which case the appropriate @code{magit-ediff-*}
command has to be used
explicitly. If it cannot read the user's mind at all, then it asks
the user for a command to run.
+@item @kbd{E} (@code{magit-ediff})
@kindex E
-@cindex magit-ediff
-@item @kbd{E} @tie{}@tie{}@tie{}@tie{}(@code{magit-ediff})
-
+@findex magit-ediff
This transient prefix command binds the following suffix commands
and displays them in a temporary buffer until a suffix is invoked.
+@item @kbd{E r} (@code{magit-ediff-compare})
@kindex E r
-@cindex magit-ediff-compare
-@item @kbd{E r} @tie{}@tie{}@tie{}@tie{}(@code{magit-ediff-compare})
-
+@findex magit-ediff-compare
Compare two revisions of a file using Ediff.
If the region is active, use the revisions on the first and last
@@ -4640,10 +4280,9 @@ line of the region. With a prefix argument, instead of
diffing the
revisions, choose a revision to view changes along, starting at the
common ancestor of both revisions (i.e., use a "@dots{}" range).
+@item @kbd{E m} (@code{magit-ediff-resolve})
@kindex E m
-@cindex magit-ediff-resolve
-@item @kbd{E m} @tie{}@tie{}@tie{}@tie{}(@code{magit-ediff-resolve})
-
+@findex magit-ediff-resolve
Resolve outstanding conflicts in a file using Ediff, defaulting to
the file at point.
@@ -4655,47 +4294,39 @@ In the rare event that you want to manually resolve all
conflicts,
including those already resolved by Git, use
@code{ediff-merge-revisions-with-ancestor}.
+@item @kbd{E s} (@code{magit-ediff-stage})
@kindex E s
-@cindex magit-ediff-stage
-@item @kbd{E s} @tie{}@tie{}@tie{}@tie{}(@code{magit-ediff-stage})
-
+@findex magit-ediff-stage
Stage and unstage changes to a file using Ediff, defaulting to the
file at point.
+@item @kbd{E u} (@code{magit-ediff-show-unstaged})
@kindex E u
-@cindex magit-ediff-show-unstaged
-@item @kbd{E u} @tie{}@tie{}@tie{}@tie{}(@code{magit-ediff-show-unstaged})
-
+@findex magit-ediff-show-unstaged
Show unstaged changes to a file using Ediff.
+@item @kbd{E i} (@code{magit-ediff-show-staged})
@kindex E i
-@cindex magit-ediff-show-staged
-@item @kbd{E i} @tie{}@tie{}@tie{}@tie{}(@code{magit-ediff-show-staged})
-
+@findex magit-ediff-show-staged
Show staged changes to a file using Ediff.
+@item @kbd{E w} (@code{magit-ediff-show-working-tree})
@kindex E w
-@cindex magit-ediff-show-working-tree
-@item @kbd{E w} @tie{}@tie{}@tie{}@tie{}(@code{magit-ediff-show-working-tree})
-
+@findex magit-ediff-show-working-tree
Show changes in a file between @code{HEAD} and working tree using Ediff.
+@item @kbd{E c} (@code{magit-ediff-show-commit})
@kindex E c
-@cindex magit-ediff-show-commit
-@item @kbd{E c} @tie{}@tie{}@tie{}@tie{}(@code{magit-ediff-show-commit})
-
+@findex magit-ediff-show-commit
Show changes to a file introduced by a commit using Ediff.
+@item @kbd{E z} (@code{magit-ediff-show-stash})
@kindex E z
-@cindex magit-ediff-show-stash
-@item @kbd{E z} @tie{}@tie{}@tie{}@tie{}(@code{magit-ediff-show-stash})
-
+@findex magit-ediff-show-stash
Show changes to a file introduced by a stash using Ediff.
-
@end table
@defopt magit-ediff-dwim-show-on-hunks
-
This option controls what command @code{magit-ediff-dwim} calls when
point is on uncommitted hunks. When nil, always run
@code{magit-ediff-stage}. Otherwise, use @code{magit-ediff-show-staged} and
@@ -4704,7 +4335,6 @@ respectively.
@end defopt
@defopt magit-ediff-show-stash-with-index
-
This option controls whether @code{magit-ediff-show-stash} includes a
buffer containing the file's state in the index at the time the
stash was created. This makes it possible to tell which changes in
@@ -4712,7 +4342,6 @@ the stash were staged.
@end defopt
@defopt magit-ediff-quit-hook
-
This hook is run after quitting an Ediff session that was created
using a Magit command. The hook functions are run inside the Ediff
control buffer, and should not change the current buffer.
@@ -4726,10 +4355,9 @@ that were created using a Magit command.
@section References Buffer
@table @asis
+@item @kbd{y} (@code{magit-show-refs})
@kindex y
-@cindex magit-show-refs
-@item @kbd{y} @tie{}@tie{}@tie{}@tie{}(@code{magit-show-refs})
-
+@findex magit-show-refs
This command lists branches and tags in a dedicated buffer.
However if this command is invoked again from this buffer or if it
@@ -4745,47 +4373,39 @@ below). These commands specify a different branch or
commit against
which all the other references are compared.
@table @asis
+@item @kbd{y y} (@code{magit-show-refs-head})
@kindex y y
-@cindex magit-show-refs-head
-@item @kbd{y y} @tie{}@tie{}@tie{}@tie{}(@code{magit-show-refs-head})
-
+@findex magit-show-refs-head
This command lists branches and tags in a dedicated buffer. Each
reference is being compared with @code{HEAD}.
+@item @kbd{y c} (@code{magit-show-refs-current})
@kindex y c
-@cindex magit-show-refs-current
-@item @kbd{y c} @tie{}@tie{}@tie{}@tie{}(@code{magit-show-refs-current})
-
+@findex magit-show-refs-current
This command lists branches and tags in a dedicated buffer. Each
reference is being compared with the current branch or @code{HEAD} if it
is detached.
+@item @kbd{y o} (@code{magit-show-refs-other})
@kindex y o
-@cindex magit-show-refs-other
-@item @kbd{y o} @tie{}@tie{}@tie{}@tie{}(@code{magit-show-refs-other})
-
+@findex magit-show-refs-other
This command lists branches and tags in a dedicated buffer. Each
reference is being compared with a branch read from the user.
+@item @kbd{y r} (@code{magit-refs-set-show-commit-count})
@kindex y r
-@cindex magit-refs-set-show-commit-count
-@item @kbd{y r}
@tie{}@tie{}@tie{}@tie{}(@code{magit-refs-set-show-commit-count})
-
+@findex magit-refs-set-show-commit-count
This command changes for which refs the commit count is shown.
-
@end table
@defopt magit-refs-show-commit-count
-
Whether to show commit counts in Magit-Refs mode buffers.
@itemize
@item
@code{all} Show counts for branches and tags.
-
@item
@code{branch} Show counts for branches only.
-
@item
@code{nil} Never show counts.
@end itemize
@@ -4794,7 +4414,6 @@ The default is @code{nil} because anything else can be
very expensive.
@end defopt
@defopt magit-refs-pad-commit-counts
-
Whether to pad all commit counts on all sides in Magit-Refs mode
buffers.
@@ -4808,7 +4427,6 @@ commit counts.
@end defopt
@defopt magit-refs-show-remote-prefix
-
Whether to show the remote prefix in lists of remote branches.
Showing the prefix is redundant because the name of the remote is
@@ -4816,7 +4434,6 @@ already shown in the heading preceding the list of its
branches.
@end defopt
@defopt magit-refs-primary-column-width
-
Width of the primary column in `magit-refs-mode' buffers. The
primary column is the column that contains the name of the branch
that the current row is about.
@@ -4830,7 +4447,6 @@ into account when calculating to optimal width.)
@end defopt
@defopt magit-refs-focus-column-width
-
Width of the focus column in `magit-refs-mode' buffers.
The focus column is the first column, which marks one branch
@@ -4846,7 +4462,6 @@ of this column.
@end defopt
@defopt magit-refs-margin
-
This option specifies whether the margin is initially shown in
Magit-Refs mode buffers and how it is formatted.
@@ -4855,7 +4470,6 @@ The value has the form @code{(INIT STYLE WIDTH AUTHOR
AUTHOR-WIDTH)}.
@itemize
@item
If INIT is non-nil, then the margin is shown initially.
-
@item
STYLE controls how to format the author or committer date. It can
be one of @code{age} (to show the age of the commit), @code{age-abbreviated}
(to
@@ -4863,15 +4477,12 @@ abbreviate the time unit to a character), or a string
(suitable
for @code{format-time-string}) to show the actual date. Option
@code{magit-log-margin-show-committer-date} controls which date is being
displayed.
-
@item
WIDTH controls the width of the margin. This exists for forward
compatibility and currently the value should not be changed.
-
@item
AUTHOR controls whether the name of the author is also shown by
default.
-
@item
AUTHOR-WIDTH has to be an integer. When the name of the author
is shown, then this specifies how much space is used to do so.
@@ -4879,7 +4490,6 @@ is shown, then this specifies how much space is used to
do so.
@end defopt
@defopt magit-refs-margin-for-tags
-
This option specifies whether to show information about tags in the
margin. This is disabled by default because it is slow if there are
many tags.
@@ -4893,39 +4503,29 @@ should also change the others to keep things aligned.
The following
@itemize
@item
@code{%a} Number of commits this ref has over the one we compare to.
-
@item
@code{%b} Number of commits the ref we compare to has over this one.
-
@item
@code{%c} Number of commits this ref has over the one we compare to. For
the ref which all other refs are compared this is instead "@@", if
it is the current branch, or "#" otherwise.
-
@item
@code{%C} For the ref which all other refs are compared this is "@@", if it
is the current branch, or "#" otherwise. For all other refs " ".
-
@item
@code{%h} Hash of this ref's tip.
-
@item
@code{%m} Commit summary of the tip of this ref.
-
@item
@code{%n} Name of this ref.
-
@item
@code{%u} Upstream of this local branch.
-
@item
@code{%U} Upstream of this local branch and additional local vs. upstream
information.
-
@end itemize
@defopt magit-refs-filter-alist
-
The purpose of this option is to forgo displaying certain refs
based on their name. If you want to not display any refs of a
certain type, then you should remove the appropriate function
@@ -4948,10 +4548,9 @@ former is used.
@end defopt
@table @asis
+@item @kbd{@key{RET}} (@code{magit-visit-ref})
@kindex RET
-@cindex magit-visit-ref
-@item @kbd{RET} @tie{}@tie{}@tie{}@tie{}(@code{magit-visit-ref})
-
+@findex magit-visit-ref
This command visits the reference or revision at point in another
buffer. If there is no revision at point or with a prefix argument
then it prompts for a revision.
@@ -4960,11 +4559,9 @@ This command behaves just like @code{magit-show-commit}
as described above,
except if point is on a reference in a @code{magit-refs-mode} buffer, in
which case the behavior may be different, but only if you have
customized the option @code{magit-visit-ref-behavior}.
-
@end table
@defopt magit-visit-ref-behavior
-
This option controls how @code{magit-visit-ref} behaves in
@code{magit-refs-mode}
buffers.
@@ -5002,7 +4599,6 @@ instead of relative to the current buffer or @code{HEAD}.
Instead of adding this symbol, consider pressing "C-u y o RET".
-
@item
@code{create-branch}
@@ -5013,7 +4609,6 @@ then check out the local branch.
Instead of adding this symbol, consider pressing "b c RET RET",
like you would do in other buffers.
-
@item
@code{checkout-any}
@@ -5023,7 +4618,6 @@ or a remote branch, then this results in a detached
@code{HEAD}.
Instead of adding this symbol, consider pressing "b b RET",
like you would do in other buffers.
-
@item
@code{checkout-branch}
@@ -5049,22 +4643,18 @@ this hook than it does for the respective hook used for
the status
buffer.
@defopt magit-refs-sections-hook
-
Hook run to insert sections into a references buffer.
@end defopt
@defun magit-insert-local-branches
-
Insert sections showing all local branches.
@end defun
@defun magit-insert-remote-branches
-
Insert sections showing all remote-tracking branches.
@end defun
@defun magit-insert-tags
-
Insert sections showing all tags.
@end defun
@@ -5085,10 +4675,9 @@ the git-bisect(1) manpage.
@end iftex
@table @asis
+@item @kbd{B} (@code{magit-bisect})
@kindex B
-@cindex magit-bisect
-@item @kbd{B} @tie{}@tie{}@tie{}@tie{}(@code{magit-bisect})
-
+@findex magit-bisect
This transient prefix command binds the following suffix commands
and displays them in a temporary buffer until a suffix is invoked.
@end table
@@ -5097,10 +4686,9 @@ When bisecting is not in progress, then the transient
features the
following suffix commands.
@table @asis
+@item @kbd{B B} (@code{magit-bisect-start})
@kindex B B
-@cindex magit-bisect-start
-@item @kbd{B B} @tie{}@tie{}@tie{}@tie{}(@code{magit-bisect-start})
-
+@findex magit-bisect-start
Start a bisect session.
Bisecting a bug means to find the commit that introduced it.
@@ -5110,10 +4698,9 @@ that isn't a regression, you can select alternate terms
that are
conceptually more fitting than "bad" and "good", but the infix
arguments to do so are disabled by default.
+@item @kbd{B s} (@code{magit-bisect-run})
@kindex B s
-@cindex magit-bisect-run
-@item @kbd{B s} @tie{}@tie{}@tie{}@tie{}(@code{magit-bisect-run})
-
+@findex magit-bisect-run
Bisect automatically by running commands after each step.
@end table
@@ -5121,41 +4708,36 @@ When bisecting in progress, then the transient instead
features the
following suffix commands.
@table @asis
+@item @kbd{B b} (@code{magit-bisect-bad})
@kindex B b
-@cindex magit-bisect-bad
-@item @kbd{B b} @tie{}@tie{}@tie{}@tie{}(@code{magit-bisect-bad})
-
+@findex magit-bisect-bad
Mark the current commit as bad. Use this after you have asserted
that the commit does contain the bug in question.
+@item @kbd{B g} (@code{magit-bisect-good})
@kindex B g
-@cindex magit-bisect-good
-@item @kbd{B g} @tie{}@tie{}@tie{}@tie{}(@code{magit-bisect-good})
-
+@findex magit-bisect-good
Mark the current commit as good. Use this after you have asserted
that the commit does not contain the bug in question.
+@item @kbd{B m} (@code{magit-bisect-mark})
@kindex B m
-@cindex magit-bisect-mark
-@item @kbd{B m} @tie{}@tie{}@tie{}@tie{}(@code{magit-bisect-mark})
-
+@findex magit-bisect-mark
Mark the current commit with one of the bisect terms. This command
provides an alternative to @code{magit-bisect-bad} and
@code{magit-bisect-good} and is useful when using terms other than "bad"
and "good". This suffix is disabled by default.
+@item @kbd{B k} (@code{magit-bisect-skip})
@kindex B k
-@cindex magit-bisect-skip
-@item @kbd{B k} @tie{}@tie{}@tie{}@tie{}(@code{magit-bisect-skip})
-
+@findex magit-bisect-skip
Skip the current commit. Use this if for some reason the current
commit is not a good one to test. This command lets Git choose a
different one.
+@item @kbd{B r} (@code{magit-bisect-reset})
@kindex B r
-@cindex magit-bisect-reset
-@item @kbd{B r} @tie{}@tie{}@tie{}@tie{}(@code{magit-bisect-reset})
-
+@findex magit-bisect-reset
After bisecting, cleanup bisection state and return to original
@code{HEAD}.
@end table
@@ -5164,7 +4746,6 @@ By default the status buffer shows information about the
ongoing
bisect session.
@defopt magit-bisect-show-graph
-
This option controls whether a graph is displayed for the log of
commits that still have to be bisected.
@end defopt
@@ -5189,25 +4770,19 @@ These commands can be used anywhere to open any blob.
Currently no
keys are bound to these commands by default, but that is likely to
change.
-@cindex magit-find-file
@deffn Command magit-find-file
-
This command reads a filename and revision from the user and visits
the respective blob in a buffer. The buffer is displayed in the
selected window.
@end deffn
-@cindex magit-find-file-other-window
@deffn Command magit-find-file-other-window
-
This command reads a filename and revision from the user and visits
the respective blob in a buffer. The buffer is displayed in another
window.
@end deffn
-@cindex magit-find-file-other-frame
@deffn Command magit-find-file-other-frame
-
This command reads a filename and revision from the user and visits
the respective blob in a buffer. The buffer is displayed in another
frame.
@@ -5219,10 +4794,9 @@ frame.
These commands can only be used when point is inside a diff.
@table @asis
+@item @kbd{@key{RET}} (@code{magit-diff-visit-file})
@kindex RET
-@cindex magit-diff-visit-file
-@item @kbd{RET} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-visit-file})
-
+@findex magit-diff-visit-file
This command visits the appropriate version of the file that the
diff at point is about.
@@ -5231,7 +4805,7 @@ The location of point inside the diff determines which
file is being
visited. The visited version depends on what changes the diff is
about.
-@itemize
+@enumerate
@item
If the diff shows uncommitted changes (i.e. staged or unstaged
changes), then visit the file in the working tree (i.e. the
@@ -5239,30 +4813,26 @@ same "real" file that @code{find-file} would visit. In
all other
cases visit a "blob" (i.e. the version of a file as stored
in some commit).
-
@item
If point is on a removed line, then visit the blob for the
first parent of the commit that removed that line, i.e. the
last commit where that line still exists.
-
@item
If point is on an added or context line, then visit the blob
that adds that line, or if the diff shows from more than a
single commit, then visit the blob from the last of these
commits.
-@end itemize
+@end enumerate
In the file-visiting buffer this command goes to the line that
corresponds to the line that point is on in the diff.
The buffer is displayed in the selected window. With a prefix
argument the buffer is displayed in another window instead.
-
@end table
@defopt magit-diff-visit-previous-blob
-
This option controls whether @code{magit-diff-visit-file} may visit the
previous blob. When this is @code{t} (the default) and point is on a
removed line in a diff for a committed change, then
@@ -5275,10 +4845,9 @@ the working tree.
@end defopt
@table @asis
+@item @kbd{C-<return>} (@code{magit-diff-visit-file-worktree})
@kindex C-<return>
-@cindex magit-diff-visit-file-worktree
-@item @kbd{C-<return>}
@tie{}@tie{}@tie{}@tie{}(@code{magit-diff-visit-file-worktree})
-
+@findex magit-diff-visit-file-worktree
This command visits the worktree version of the appropriate file.
The location of point inside the diff determines which file is being
visited. Unlike @code{magit-diff-visit-file} it always visits the "real"
@@ -5299,16 +4868,12 @@ then you may want to change the above key bindings, but
note that the
above commands also use another window when invoked with a prefix
argument.
-@cindex magit-diff-visit-file-other-window
@deffn Command magit-diff-visit-file-other-window
@end deffn
-@cindex magit-diff-visit-file-other-frame
@deffn Command magit-diff-visit-file-other-frame
@end deffn
-@cindex magit-diff-visit-worktree-file-other-window
@deffn Command magit-diff-visit-worktree-file-other-window
@end deffn
-@cindex magit-diff-visit-worktree-file-other-frame
@deffn Command magit-diff-visit-worktree-file-other-frame
@end deffn
@@ -5339,10 +4904,9 @@ The key bindings shown below assume that you enter the
dispatch
transient using the default binding.
@table @asis
+@item @kbd{C-c M-g B} (@code{magit-blame})
@kindex C-c M-g B
-@cindex magit-blame
-@item @kbd{C-c M-g B} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame})
-
+@findex magit-blame
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
@@ -5354,13 +4918,12 @@ command whose purpose is to turn off that mode would
not be of any
use and therefore isn't available.
@table @asis
+@item @kbd{C-c M-g b} (@code{magit-blame-addition})
@kindex C-c M-g b
-@cindex magit-blame-addition
-@item @kbd{C-c M-g b} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-addition})
-@kindex C-c M-g B b
-@cindex magit-blame-addition
-@item @kbd{C-c M-g B b} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-addition})
+@findex magit-blame-addition
+@item @kbd{C-c M-g B b}
+@kindex C-c M-g B b
This command augments each line or chunk of lines in the current
file-visiting or blob-visiting buffer with information about what
commits last touched these lines.
@@ -5374,39 +4937,36 @@ blaming is done recursively, by visiting REVISION:FILE
(using
@code{magit-find-file}), where REVISION is a parent of the revision that
added the current line or chunk of lines.
+@item @kbd{C-c M-g r} (@code{magit-blame-removal})
@kindex C-c M-g r
-@cindex magit-blame-removal
-@item @kbd{C-c M-g r} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-removal})
-@kindex C-c M-g B r
-@cindex magit-blame-removal
-@item @kbd{C-c M-g B r} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-removal})
+@findex magit-blame-removal
+@item @kbd{C-c M-g B r}
+@kindex C-c M-g B r
This command augments each line or chunk of lines in the current
blob-visiting buffer with information about the revision that
removes it. It cannot be used in file-visiting buffers.
Like @code{magit-blame-addition}, this command can be used recursively.
+@item @kbd{C-c M-g f} (@code{magit-blame-reverse})
@kindex C-c M-g f
-@cindex magit-blame-reverse
-@item @kbd{C-c M-g f} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-reverse})
-@kindex C-c M-g B f
-@cindex magit-blame-reverse
-@item @kbd{C-c M-g B f} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-reverse})
+@findex magit-blame-reverse
+@item @kbd{C-c M-g B f}
+@kindex C-c M-g B f
This command augments each line or chunk of lines in the current
file-visiting or blob-visiting buffer with information about the
last revision in which a line still existed.
Like @code{magit-blame-addition}, this command can be used recursively.
+@item @kbd{C-c M-g e} (@code{magit-blame-echo})
@kindex C-c M-g e
-@cindex magit-blame-echo
-@item @kbd{C-c M-g e} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-echo})
-@kindex C-c M-g B e
-@cindex magit-blame-echo
-@item @kbd{C-c M-g B e} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-echo})
+@findex magit-blame-echo
+@item @kbd{C-c M-g B e}
+@kindex C-c M-g B e
This command is like @code{magit-blame-addition} except that it doesn't
turn on @code{read-only-mode} and that it initially uses the visualization
style specified by option @code{magit-blame-echo-style}.
@@ -5418,16 +4978,14 @@ available in other buffers; here only the behavior is
described that
is relevant in file-visiting buffers that are being blamed.
@table @asis
+@item @kbd{@key{RET}} (@code{magit-show-commit})
@kindex RET
-@cindex magit-show-commit
-@item @kbd{RET} @tie{}@tie{}@tie{}@tie{}(@code{magit-show-commit})
-
+@findex magit-show-commit
This command shows the commit that last touched the line at point.
+@item @kbd{@key{SPC}} (@code{magit-diff-show-or-scroll-up})
@kindex SPC
-@cindex magit-diff-show-or-scroll-up
-@item @kbd{SPC} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-show-or-scroll-up})
-
+@findex magit-diff-show-or-scroll-up
This command updates the commit buffer.
This either shows the commit that last touched the line at point in
@@ -5435,10 +4993,9 @@ the appropriate buffer, or if that buffer is already
being displayed
in the current frame and if that buffer contains information about
that commit, then the buffer is scrolled up instead.
+@item @kbd{DEL} (@code{magit-diff-show-or-scroll-down})
@kindex DEL
-@cindex magit-diff-show-or-scroll-down
-@item @kbd{DEL} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-show-or-scroll-down})
-
+@findex magit-diff-show-or-scroll-down
This command updates the commit buffer.
This either shows the commit that last touched the line at point in
@@ -5451,57 +5008,49 @@ The following key bindings are available when both
Magit-Blame mode
and Read-Only mode are enabled.
@table @asis
+@item @kbd{b} (@code{magit-blame})
@kindex b
-@cindex magit-blame
-@item @kbd{b} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame})
-
+@findex magit-blame
See above.
+@item @kbd{n} (@code{magit-blame-next-chunk})
@kindex n
-@cindex magit-blame-next-chunk
-@item @kbd{n} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-next-chunk})
-
+@findex magit-blame-next-chunk
This command moves to the next chunk.
+@item @kbd{N} (@code{magit-blame-next-chunk-same-commit})
@kindex N
-@cindex magit-blame-next-chunk-same-commit
-@item @kbd{N}
@tie{}@tie{}@tie{}@tie{}(@code{magit-blame-next-chunk-same-commit})
-
+@findex magit-blame-next-chunk-same-commit
This command moves to the next chunk from the same commit.
+@item @kbd{p} (@code{magit-blame-previous-chunk})
@kindex p
-@cindex magit-blame-previous-chunk
-@item @kbd{p} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-previous-chunk})
-
+@findex magit-blame-previous-chunk
This command moves to the previous chunk.
+@item @kbd{P} (@code{magit-blame-previous-chunk-same-commit})
@kindex P
-@cindex magit-blame-previous-chunk-same-commit
-@item @kbd{P}
@tie{}@tie{}@tie{}@tie{}(@code{magit-blame-previous-chunk-same-commit})
-
+@findex magit-blame-previous-chunk-same-commit
This command moves to the previous chunk from the same commit.
+@item @kbd{q} (@code{magit-blame-quit})
@kindex q
-@cindex magit-blame-quit
-@item @kbd{q} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-quit})
-
+@findex magit-blame-quit
This command turns off Magit-Blame mode. If the buffer was created
during a recursive blame, then it also kills the buffer.
+@item @kbd{M-w} (@code{magit-blame-copy-hash})
@kindex M-w
-@cindex magit-blame-copy-hash
-@item @kbd{M-w} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-copy-hash})
-
+@findex magit-blame-copy-hash
This command saves the hash of the current chunk's commit to the
kill ring.
When the region is active, the command saves the region's content
instead of the hash, like @code{kill-ring-save} would.
+@item @kbd{c} (@code{magit-blame-cycle-style})
@kindex c
-@cindex magit-blame-cycle-style
-@item @kbd{c} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-cycle-style})
-
+@findex magit-blame-cycle-style
This command changes how blame information is visualized in the
current buffer by cycling through the styles specified using the
option @code{magit-blame-styles}.
@@ -5510,39 +5059,33 @@ option @code{magit-blame-styles}.
Blaming is also controlled using the following options.
@defopt magit-blame-styles
-
This option defines a list of styles used to visualize blame
information. For now see its doc-string to learn more.
@end defopt
@defopt magit-blame-echo-style
-
This option specifies the blame visualization style used by the
command @code{magit-blame-echo}. This must be a symbol that is used as the
identifier for one of the styles defined in @code{magit-blame-styles}.
@end defopt
@defopt magit-blame-time-format
-
This option specifies the format string used to display times when
showing blame information.
@end defopt
@defopt magit-blame-read-only
-
This option controls whether blaming a buffer also makes temporarily
read-only.
@end defopt
@defopt magit-blame-disable-modes
-
This option lists incompatible minor-modes that should be disabled
temporarily when a buffer contains blame information. They are
enabled again when the buffer no longer shows blame information.
@end defopt
@defopt magit-blame-goto-chunk-hook
-
This hook is run when moving between chunks.
@end defopt
@@ -5568,10 +5111,9 @@ This hook is run when moving between chunks.
@section Creating Repository
@table @asis
+@item @kbd{I} (@code{magit-init})
@kindex I
-@cindex magit-init
-@item @kbd{I} @tie{}@tie{}@tie{}@tie{}(@code{magit-init})
-
+@findex magit-init
This command initializes a repository and then shows the status
buffer for the new repository.
@@ -5591,7 +5133,6 @@ it can invoke @code{git clone} directly, depending on
whether a prefix
argument is used and on the value of @code{magit-clone-always-transient}.
@defopt magit-clone-always-transient
-
This option controls whether the command @code{magit-clone} always acts as
a transient prefix command, regardless of whether a prefix argument
is used or not. If @code{t}, then that command always acts as a transient
@@ -5600,10 +5141,9 @@ as a transient.
@end defopt
@table @asis
+@item @kbd{C} (@code{magit-clone})
@kindex C
-@cindex magit-clone
-@item @kbd{C} @tie{}@tie{}@tie{}@tie{}(@code{magit-clone})
-
+@findex magit-clone
This command either acts as a transient prefix command as described
above or does the same thing as @code{transient-clone-regular} as described
below.
@@ -5611,33 +5151,29 @@ below.
If it acts as a transient prefix, then it binds the following suffix
commands and several infix arguments.
+@item @kbd{C C} (@code{magit-clone-regular})
@kindex C C
-@cindex magit-clone-regular
-@item @kbd{C C} @tie{}@tie{}@tie{}@tie{}(@code{magit-clone-regular})
-
+@findex magit-clone-regular
This command creates a regular clone of an existing repository.
The repository and the target directory are read from the user.
+@item @kbd{C s} (@code{magit-clone-shallow})
@kindex C s
-@cindex magit-clone-shallow
-@item @kbd{C s} @tie{}@tie{}@tie{}@tie{}(@code{magit-clone-shallow})
-
+@findex magit-clone-shallow
This command creates a shallow clone of an existing repository.
The repository and the target directory are read from the user.
By default the depth of the cloned history is a single commit,
but with a prefix argument the depth is read from the user.
+@item @kbd{C b} (@code{magit-clone-bare})
@kindex C b
-@cindex magit-clone-bare
-@item @kbd{C b} @tie{}@tie{}@tie{}@tie{}(@code{magit-clone-bare})
-
+@findex magit-clone-bare
This command creates a bare clone of an existing repository.
The repository and the target directory are read from the user.
+@item @kbd{C m} (@code{magit-clone-mirror})
@kindex C m
-@cindex magit-clone-mirror
-@item @kbd{C m} @tie{}@tie{}@tie{}@tie{}(@code{magit-clone-mirror})
-
+@findex magit-clone-mirror
This command creates a mirror of an existing repository.
The repository and the target directory are read from the user.
@end table
@@ -5646,28 +5182,24 @@ The following suffixes are disabled by default. See
@ref{Enabling and Disabling Suffixes,,,transient,} for how to enable them.
@table @asis
+@item @kbd{C d} (@code{magit-clone-shallow-since})
@kindex C d
-@cindex magit-clone-shallow-since
-@item @kbd{C d} @tie{}@tie{}@tie{}@tie{}(@code{magit-clone-shallow-since})
-
+@findex magit-clone-shallow-since
This command creates a shallow clone of an existing repository.
Only commits that were committed after a date are cloned, which
is read from the user. The repository and the target directory
are also read from the user.
+@item @kbd{C e} (@code{magit-clone-shallow-exclude})
@kindex C e
-@cindex magit-clone-shallow-exclude
-@item @kbd{C e} @tie{}@tie{}@tie{}@tie{}(@code{magit-clone-shallow-exclude})
-
+@findex magit-clone-shallow-exclude
This command creates a shallow clone of an existing repository.
This reads a branch or tag from the user. Commits that are
reachable from that are not cloned. The repository and the target
directory are also read from the user.
-
@end table
@defopt magit-clone-set-remote-head
-
This option controls whether cloning causes the reference
@code{refs/remotes/<remote>/HEAD} to be created in the clone. The default
is to delete the reference after running @code{git clone}, which insists on
@@ -5678,35 +5210,29 @@ default behavior of creating the reference.
@end defopt
@defopt magit-clone-set-remote.pushDefault
-
This option controls whether the value of the Git variable
@code{remote.pushDefault} is set after cloning.
@itemize
@item
If @code{t}, then it is always set without asking.
-
@item
If @code{ask}, then the users are asked every time they clone a
repository.
-
@item
If @code{nil}, then it is never set.
@end itemize
@end defopt
@defopt magit-clone-default-directory
-
This option control the default directory name used when reading the
destination for a cloning operation.
@itemize
@item
If @code{nil} (the default), then the value of @code{default-directory} is
used.
-
@item
If a directory, then that is used.
-
@item
If a function, then that is called with the remote url as the only
argument and the returned value is used.
@@ -5714,7 +5240,6 @@ argument and the returned value is used.
@end defopt
@defopt magit-clone-name-alist
-
This option maps regular expressions, which match repository names,
to repository urls, making it possible for users to enter short
names instead of urls when cloning repositories.
@@ -5736,7 +5261,6 @@ username itself.
@end defopt
@defopt magit-clone-url-format
-
The format specified by this option is used when turning repository
names into urls. @code{%h} is the hostname and @code{%n} is the repository
name,
including the name of the owner.
@@ -5768,29 +5292,26 @@ apply variants are described in the next section.
You can also use Ediff to stage and unstage. See @ref{Ediffing}.
@table @asis
+@item @kbd{s} (@code{magit-stage})
@kindex s
-@cindex magit-stage
-@item @kbd{s} @tie{}@tie{}@tie{}@tie{}(@code{magit-stage})
-
+@findex magit-stage
Add the change at point to the staging area.
With a prefix argument and an untracked file (or files) at point,
stage the file but not its content. This makes it possible to stage
only a subset of the new file's changes.
+@item @kbd{S} (@code{magit-stage-modified})
@kindex S
-@cindex magit-stage-modified
-@item @kbd{S} @tie{}@tie{}@tie{}@tie{}(@code{magit-stage-modified})
-
+@findex magit-stage-modified
Stage all changes to files modified in the worktree. Stage all new
content of tracked files and remove tracked files that no longer
exist in the working tree from the index also. With a prefix
argument also stage previously untracked (but not ignored) files.
+@item @kbd{u} (@code{magit-unstage})
@kindex u
-@cindex magit-unstage
-@item @kbd{u} @tie{}@tie{}@tie{}@tie{}(@code{magit-unstage})
-
+@findex magit-unstage
Remove the change at point from the staging area.
Only staged changes can be unstaged. But by default this command
@@ -5798,26 +5319,21 @@ performs an action that is somewhat similar to
unstaging, when it is
called on a committed change: it reverses the change in the index
but not in the working tree.
+@item @kbd{U} (@code{magit-unstage-all})
@kindex U
-@cindex magit-unstage-all
-@item @kbd{U} @tie{}@tie{}@tie{}@tie{}(@code{magit-unstage-all})
-
+@findex magit-unstage-all
Remove all changes from the staging area.
-
@end table
@defopt magit-unstage-committed
-
This option controls whether @code{magit-unstage} "unstages" committed
changes by reversing them in the index but not the working tree.
The alternative is to raise an error.
@end defopt
@table @asis
-@kindex M-x magit-reverse-in-index
-@cindex magit-reverse-in-index
-@item @kbd{M-x magit-reverse-in-index}
@tie{}@tie{}@tie{}@tie{}(@code{magit-reverse-in-index})
-
+@item @kbd{M-x magit-reverse-in-index}
+@findex magit-reverse-in-index
This command reverses the committed change at point in the index but
not the working tree. By default no key is bound directly to this
command, but it is indirectly called when @code{u} (@code{magit-unstage}) is
@@ -5827,31 +5343,25 @@ This allows extracting a change from @code{HEAD}, while
leaving it in the
working tree, so that it can later be committed using a separate
commit. A typical workflow would be:
-@itemize
+@enumerate
@item
Optionally make sure that there are no uncommitted changes.
-
@item
Visit the @code{HEAD} commit and navigate to the change that should
not have been included in that commit.
-
@item
Type @code{u} (@code{magit-unstage}) to reverse it in the index.
This assumes that @code{magit-unstage-committed-changes} is non-nil.
-
@item
Type @code{c e} to extend @code{HEAD} with the staged changes,
including those that were already staged before.
-
@item
Optionally stage the remaining changes using @code{s} or @code{S} and then
type @code{c c} to create a new commit.
-@end itemize
-
-@kindex M-x magit-reset-index
-@cindex magit-reset-index
-@item @kbd{M-x magit-reset-index}
@tie{}@tie{}@tie{}@tie{}(@code{magit-reset-index})
+@end enumerate
+@item @kbd{M-x magit-reset-index}
+@findex magit-reset-index
Reset the index to some commit. The commit is read from the user
and defaults to the commit at point. If there is no commit at
point, then it defaults to @code{HEAD}.
@@ -5869,20 +5379,16 @@ buffer, but it's also possible to un-/stage all changes
made to the
file visited in the current buffer right from inside that buffer.
@table @asis
-@kindex M-x magit-stage-file
-@cindex magit-stage-file
-@item @kbd{M-x magit-stage-file}
@tie{}@tie{}@tie{}@tie{}(@code{magit-stage-file})
-
+@item @kbd{M-x magit-stage-file}
+@findex magit-stage-file
When invoked inside a file-visiting buffer, then stage all changes
to that file. In a Magit buffer, stage the file at point if any.
Otherwise prompt for a file to be staged. With a prefix argument
always prompt the user for a file, even in a file-visiting buffer or
when there is a file section at point.
-@kindex M-x magit-unstage-file
-@cindex magit-unstage-file
-@item @kbd{M-x magit-unstage-file}
@tie{}@tie{}@tie{}@tie{}(@code{magit-unstage-file})
-
+@item @kbd{M-x magit-unstage-file}
+@findex magit-unstage-file
When invoked inside a file-visiting buffer, then unstage all changes
to that file. In a Magit buffer, unstage the file at point if any.
Otherwise prompt for a file to be unstaged. With a prefix argument
@@ -5903,23 +5409,19 @@ are all implemented using @code{git apply}, which is
why they are called
Stage. Apply a change from the working tree to the index. The change
also remains in the working tree.
-
@item
Unstage. Remove a change from the index. The change remains in the
working tree.
-
@item
Discard. On a staged change, remove it from the working tree and the
index. On an unstaged change, remove it from the working tree only.
-
@item
Reverse. Reverse a change in the working tree. Both committed and
staged changes can be reversed. Unstaged changes cannot be
reversed. Discard them instead.
-
@item
Apply. Apply a change to the working tree. Both committed and staged
changes can be applied. Unstaged changes cannot be applied - as
@@ -5931,29 +5433,26 @@ What follows are the commands which implement the
remaining apply
variants.
@table @asis
+@item @kbd{a} (@code{magit-apply})
@kindex a
-@cindex magit-apply
-@item @kbd{a} @tie{}@tie{}@tie{}@tie{}(@code{magit-apply})
-
+@findex magit-apply
Apply the change at point to the working tree.
With a prefix argument fallback to a 3-way merge. Doing so causes
the change to be applied to the index as well.
+@item @kbd{k} (@code{magit-discard})
@kindex k
-@cindex magit-discard
-@item @kbd{k} @tie{}@tie{}@tie{}@tie{}(@code{magit-discard})
-
+@findex magit-discard
Remove the change at point from the working tree.
On a hunk or file with unresolved conflicts prompt which side to
keep (while discarding the other). If point is within the text
of a side, then keep that side without prompting.
+@item @kbd{v} (@code{magit-reverse})
@kindex v
-@cindex magit-reverse
-@item @kbd{v} @tie{}@tie{}@tie{}@tie{}(@code{magit-reverse})
-
+@findex magit-reverse
Reverse the change at point in the working tree.
With a prefix argument fallback to a 3-way merge. Doing so causes
@@ -5995,31 +5494,27 @@ the git-commit(1) manpage.
@end iftex
@table @asis
+@item @kbd{c} (@code{magit-commit})
@kindex c
-@cindex magit-commit
-@item @kbd{c} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit})
-
+@findex magit-commit
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
+@item @kbd{c c} (@code{magit-commit-create})
@kindex c c
-@cindex magit-commit-create
-@item @kbd{c c} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit-create})
-
+@findex magit-commit-create
Create a new commit on @code{HEAD}. With a prefix argument amend to the
commit at @code{HEAD} instead.
+@item @kbd{c a} (@code{magit-commit-amend})
@kindex c a
-@cindex magit-commit-amend
-@item @kbd{c a} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit-amend})
-
+@findex magit-commit-amend
Amend the last commit.
+@item @kbd{c e} (@code{magit-commit-extend})
@kindex c e
-@cindex magit-commit-extend
-@item @kbd{c e} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit-extend})
-
+@findex magit-commit-extend
Amend the last commit, without editing the message. With a prefix
argument keep the committer date, otherwise change it. The option
@code{magit-commit-extend-override-date} can be used to inverse the meaning
@@ -6028,10 +5523,9 @@ of the prefix argument.
Non-interactively respect the optional OVERRIDE-DATE argument and
ignore the option.
+@item @kbd{c w} (@code{magit-commit-reword})
@kindex c w
-@cindex magit-commit-reword
-@item @kbd{c w} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit-reword})
-
+@findex magit-commit-reword
Reword the last commit, ignoring staged changes. With a prefix
argument keep the committer date, otherwise change it. The option
@code{magit-commit-reword-override-date} can be used to inverse the meaning
@@ -6040,73 +5534,62 @@ of the prefix argument.
Non-interactively respect the optional OVERRIDE-DATE argument and
ignore the option.
+@item @kbd{c f} (@code{magit-commit-fixup})
@kindex c f
-@cindex magit-commit-fixup
-@item @kbd{c f} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit-fixup})
-
+@findex magit-commit-fixup
Create a fixup commit.
With a prefix argument the target commit has to be confirmed.
Otherwise the commit at point may be used without confirmation
depending on the value of option @code{magit-commit-squash-confirm}.
+@item @kbd{c F} (@code{magit-commit-instant-fixup})
@kindex c F
-@cindex magit-commit-instant-fixup
-@item @kbd{c F} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit-instant-fixup})
-
+@findex magit-commit-instant-fixup
Create a fixup commit and instantly rebase.
+@item @kbd{c s} (@code{magit-commit-squash})
@kindex c s
-@cindex magit-commit-squash
-@item @kbd{c s} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit-squash})
-
+@findex magit-commit-squash
Create a squash commit, without editing the squash message.
With a prefix argument the target commit has to be confirmed.
Otherwise the commit at point may be used without confirmation
depending on the value of option @code{magit-commit-squash-confirm}.
+@item @kbd{c S} (@code{magit-commit-instant-squash})
@kindex c S
-@cindex magit-commit-instant-squash
-@item @kbd{c S} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit-instant-squash})
-
+@findex magit-commit-instant-squash
Create a squash commit and instantly rebase.
+@item @kbd{c A} (@code{magit-commit-augment})
@kindex c A
-@cindex magit-commit-augment
-@item @kbd{c A} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit-augment})
-
+@findex magit-commit-augment
Create a squash commit, editing the squash message.
With a prefix argument the target commit has to be confirmed.
Otherwise the commit at point may be used without confirmation
depending on the value of option @code{magit-commit-squash-confirm}.
-
@end table
@defopt magit-commit-ask-to-stage
-
Whether to ask to stage all unstaged changes when committing and nothing is
staged.
@end defopt
@defopt magit-commit-show-diff
-
Whether the relevant diff is automatically shown when committing.
@end defopt
@defopt magit-commit-extend-override-date
-
Whether using @code{magit-commit-extend} changes the committer date.
@end defopt
@defopt magit-commit-reword-override-date
-
Whether using @code{magit-commit-reword} changes the committer date.
@end defopt
@defopt magit-commit-squash-confirm
-
Whether the commit targeted by squash and fixup has to be confirmed.
When non-nil then the commit at point (if any) is used as default
choice. Otherwise it has to be confirmed. This option only affects
@@ -6116,7 +5599,6 @@ those is harder to recover from.
@end defopt
@defopt magit-post-commit-hook
-
Hook run after creating a commit without the user editing a message.
This hook is run by @code{magit-refresh} if @code{this-command} is a member
@@ -6128,7 +5610,6 @@ Also see @code{git-commit-post-finish-hook}.
@end defopt
@defopt magit-commit-diff-inhibit-same-window
-
Whether to inhibit use of same window when showing diff while
committing.
@@ -6170,17 +5651,15 @@ create the commit. So the most important commands are
those for
finishing and aborting the commit.
@table @asis
+@item @kbd{C-c C-c} (@code{with-editor-finish})
@kindex C-c C-c
-@cindex with-editor-finish
-@item @kbd{C-c C-c} @tie{}@tie{}@tie{}@tie{}(@code{with-editor-finish})
-
+@findex with-editor-finish
Finish the current editing session by returning with exit code 0.
Git then creates the commit using the message it finds in the file.
+@item @kbd{C-c C-k} (@code{with-editor-cancel})
@kindex C-c C-k
-@cindex with-editor-cancel
-@item @kbd{C-c C-k} @tie{}@tie{}@tie{}@tie{}(@code{with-editor-cancel})
-
+@findex with-editor-cancel
Cancel the current editing session by returning with exit code 1.
Git then cancels the commit, but leaves the file untouched.
@end table
@@ -6192,24 +5671,21 @@ of whether the session is finished successfully or was
canceled). It
is sometimes useful to bring back messages from that ring.
@table @asis
+@item @kbd{C-c M-s} (@code{git-commit-save-message})
@kindex C-c M-s
-@cindex git-commit-save-message
-@item @kbd{C-c M-s} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-save-message})
-
+@findex git-commit-save-message
Save the current buffer content to the commit message ring.
+@item @kbd{M-p} (@code{git-commit-prev-message})
@kindex M-p
-@cindex git-commit-prev-message
-@item @kbd{M-p} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-prev-message})
-
+@findex git-commit-prev-message
Cycle backward through the commit message ring, after saving the
current message to the ring. With a numeric prefix ARG, go back
ARG comments.
+@item @kbd{M-n} (@code{git-commit-next-message})
@kindex M-n
-@cindex git-commit-next-message
-@item @kbd{M-n} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-next-message})
-
+@findex git-commit-next-message
Cycle forward through the commit message ring, after saving the
current message to the ring. With a numeric prefix ARG, go back
ARG comments.
@@ -6224,10 +5700,9 @@ the changes that are about to be added to that commit or
to show those
changes alongside those that have already been committed.
@table @asis
+@item @kbd{C-c C-d} (@code{magit-diff-while-committing})
@kindex C-c C-d
-@cindex magit-diff-while-committing
-@item @kbd{C-c C-d}
@tie{}@tie{}@tie{}@tie{}(@code{magit-diff-while-committing})
-
+@findex magit-diff-while-committing
While committing, show the changes that are about to be committed.
While amending, invoking the command again toggles between showing
just the new changes or all the changes that will be committed.
@@ -6244,10 +5719,9 @@ just the new changes or all the changes that will be
committed.
@unnumberedsubsubsec Using the Revision Stack
@table @asis
+@item @kbd{C-c C-w} (@code{magit-pop-revision-stack})
@kindex C-c C-w
-@cindex magit-pop-revision-stack
-@item @kbd{C-c C-w} @tie{}@tie{}@tie{}@tie{}(@code{magit-pop-revision-stack})
-
+@findex magit-pop-revision-stack
This command inserts a representation of a revision into the current
buffer. It can be used inside buffers used to write commit messages
but also in other buffers such as buffers used to edit emails or
@@ -6274,11 +5748,9 @@ element of the stack is used (even though we insert
another
revision). If not called inside a repository and with an empty
stack, or with two prefix arguments, then read the repository in
the minibuffer too.
-
@end table
@defopt magit-pop-revision-stack-format
-
This option controls how the command @code{magit-pop-revision-stack}
inserts a revision into the current buffer.
@@ -6313,58 +5785,49 @@ Some projects use pseudo headers in commit messages.
Magit colorizes
such headers and provides some commands to insert such headers.
@defopt git-commit-known-pseudo-headers
-
A list of Git pseudo headers to be highlighted.
@end defopt
@table @asis
+@item @kbd{C-c C-i} (@code{git-commit-insert-pseudo-header})
@kindex C-c C-i
-@cindex git-commit-insert-pseudo-header
-@item @kbd{C-c C-i}
@tie{}@tie{}@tie{}@tie{}(@code{git-commit-insert-pseudo-header})
-
+@findex git-commit-insert-pseudo-header
Insert a commit message pseudo header.
+@item @kbd{C-c C-a} (@code{git-commit-ack})
@kindex C-c C-a
-@cindex git-commit-ack
-@item @kbd{C-c C-a} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-ack})
-
+@findex git-commit-ack
Insert a header acknowledging that you have looked at the commit.
+@item @kbd{C-c C-r} (@code{git-commit-review})
@kindex C-c C-r
-@cindex git-commit-review
-@item @kbd{C-c C-r} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-review})
-
+@findex git-commit-review
Insert a header acknowledging that you have reviewed the commit.
+@item @kbd{C-c C-s} (@code{git-commit-signoff})
@kindex C-c C-s
-@cindex git-commit-signoff
-@item @kbd{C-c C-s} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-signoff})
-
+@findex git-commit-signoff
Insert a header to sign off the commit.
+@item @kbd{C-c C-t} (@code{git-commit-test})
@kindex C-c C-t
-@cindex git-commit-test
-@item @kbd{C-c C-t} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-test})
-
+@findex git-commit-test
Insert a header acknowledging that you have tested the commit.
+@item @kbd{C-c C-o} (@code{git-commit-cc})
@kindex C-c C-o
-@cindex git-commit-cc
-@item @kbd{C-c C-o} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-cc})
-
+@findex git-commit-cc
Insert a header mentioning someone who might be interested.
+@item @kbd{C-c C-p} (@code{git-commit-reported})
@kindex C-c C-p
-@cindex git-commit-reported
-@item @kbd{C-c C-p} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-reported})
-
+@findex git-commit-reported
Insert a header mentioning the person who reported the issue being
fixed by the commit.
+@item @kbd{C-c M-i} (@code{git-commit-suggested})
@kindex C-c M-i
-@cindex git-commit-suggested
-@item @kbd{C-c M-i} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-suggested})
-
+@findex git-commit-suggested
Insert a header mentioning the person who suggested the change.
@end table
@@ -6378,7 +5841,6 @@ different major modes in different repositories, which is
useful when
different projects impose different commit message conventions.
@defopt git-commit-major-mode
-
The value of this option is the major mode used to edit Git commit
messages.
@end defopt
@@ -6390,7 +5852,6 @@ the hook @code{git-commit-setup-hook}.
@defopt git-commit-setup-hook
-
Hook run at the end of @code{git-commit-setup}.
@end defopt
@@ -6398,30 +5859,25 @@ Hook run at the end of @code{git-commit-setup}.
The following functions are suitable for this hook:
@defun git-commit-save-message
-
Save the current buffer content to the commit message ring.
@end defun
@defun git-commit-setup-changelog-support
-
After this function is called, ChangeLog entries are treated as
paragraphs.
@end defun
@defun git-commit-turn-on-auto-fill
-
Turn on @code{auto-fill-mode} and set @code{fill-column} to the value of
@code{git-commit-fill-column}.
@end defun
@defun git-commit-turn-on-flyspell
-
Turn on Flyspell mode. Also prevent comments from being checked and
finally check current non-comment text.
@end defun
@defun git-commit-propertize-diff
-
Propertize the diff shown inside the commit message buffer. Git
inserts such diffs into the commit message template when the
@code{--verbose} argument is used. @code{magit-commit} by default does not
offer
@@ -6431,17 +5887,14 @@ exists.
@end defun
@defun bug-reference-mode
-
Hyperlink bug references in the buffer.
@end defun
@defun with-editor-usage-message
-
Show usage information in the echo area.
@end defun
@defopt git-commit-setup-hook
-
Hook run after the user finished writing a commit message.
This hook is only run after pressing @code{C-c C-c} in a buffer used to
@@ -6469,20 +5922,17 @@ instead of some code it's now the human who is
reviewing your commits
who has to waste some time telling you to fix your commits.
@defopt git-commit-summary-max-length
-
The intended maximal length of the summary line of commit messages.
Characters beyond this column are colorized to indicate that this
preference has been violated.
@end defopt
@defopt git-commit-fill-column
-
Column beyond which automatic line-wrapping should happen in commit
message buffers.
@end defopt
@defopt git-commit-finish-query-functions
-
List of functions called to query before performing commit.
The commit message buffer is current while the functions are called.
@@ -6499,14 +5949,12 @@ By default the only member is
@code{git-commit-check-style-conventions}.
@end defopt
@defun git-commit-check-style-conventions
-
This function checks for violations of certain basic style
conventions. For each violation it asks users if they want to
proceed anyway.
@end defun
@defopt git-commit-style-convention-checks
-
This option controls what conventions the function by the same name
tries to enforce. The value is a list of self-explanatory symbols
identifying certain conventions; @code{non-empty-second-line} and
@@ -6581,20 +6029,17 @@ from them. Those features are available from separate
transient
command.
@table @asis
+@item @kbd{b} (@code{magit-branch})
@kindex b
-@cindex magit-branch
-@item @kbd{b} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch})
-
+@findex magit-branch
This transient prefix command binds the following suffix commands
and displays them in a temporary buffer until a suffix is invoked.
By default it also binds and displays the values of some
branch-related Git variables and allows changing their values.
-
@end table
@defopt magit-branch-direct-configure
-
This option controls whether the transient command @code{magit-branch} can
be used to directly change the values of Git variables. This defaults
to @code{t} (to avoid changing key bindings). When set to @code{nil}, then no
@@ -6604,19 +6049,15 @@ change branch related variables.
@end defopt
@table @asis
+@item @kbd{b C} (@code{magit-branch-configure})
+@itemx @kbd{f C}
+@itemx @kbd{F C}
+@itemx @kbd{P C}
@kindex b C
-@cindex magit-branch-configure
-@item @kbd{b C} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-configure})
@kindex f C
-@cindex magit-branch-configure
-@item @kbd{f C} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-configure})
@kindex F C
-@cindex magit-branch-configure
-@item @kbd{F C} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-configure})
@kindex P C
-@cindex magit-branch-configure
-@item @kbd{P C} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-configure})
-
+@findex magit-branch-configure
This transient prefix command binds commands that set the value of
branch-related variables and displays them in a temporary buffer
until the transient is exited.
@@ -6634,20 +6075,18 @@ prompts for a branch.
The variables are described in @ref{Branch Git Variables}.
@table @asis
+@item @kbd{b b} (@code{magit-checkout})
@kindex b b
-@cindex magit-checkout
-@item @kbd{b b} @tie{}@tie{}@tie{}@tie{}(@code{magit-checkout})
-
+@findex magit-checkout
Checkout a revision read in the minibuffer and defaulting to the
branch or arbitrary revision at point. If the revision is a local
branch then that becomes the current branch. If it is something
else then @code{HEAD} becomes detached. Checkout fails if the working tree
or the staging area contain changes.
+@item @kbd{b n} (@code{magit-branch-create})
@kindex b n
-@cindex magit-branch-create
-@item @kbd{b n} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-create})
-
+@findex magit-branch-create
Create a new branch. The user is asked for a branch or arbitrary
revision to use as the starting point of the new branch. When a
branch name is provided, then that becomes the upstream branch of
@@ -6656,19 +6095,17 @@ minibuffer.
Also see option @code{magit-branch-prefer-remote-upstream}.
+@item @kbd{b c} (@code{magit-branch-and-checkout})
@kindex b c
-@cindex magit-branch-and-checkout
-@item @kbd{b c} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-and-checkout})
-
+@findex magit-branch-and-checkout
This command creates a new branch like @code{magit-branch-create}, but then
also checks it out.
Also see option @code{magit-branch-prefer-remote-upstream}.
+@item @kbd{b l} (@code{magit-branch-checkout})
@kindex b l
-@cindex magit-branch-checkout
-@item @kbd{b l} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-checkout})
-
+@findex magit-branch-checkout
This command checks out an existing or new local branch. It reads a
branch name from the user offering all local branches and a subset
of remote branches as candidates. Remote branches for which a local
@@ -6680,13 +6117,11 @@ candidates. The user can also enter a completely new
branch name.
If the user selects an existing local branch, then that is checked
out.
-
@item
If the user selects a remote branch, then it creates and checks
out a new local branch with the same name, and configures the
selected remote branch as the push target.
-
@item
If the user enters a new branch name, then it creates and checks
that out, after also reading the starting-point from the user.
@@ -6696,10 +6131,9 @@ In the latter two cases the upstream is also set.
Whether it is set
to the chosen starting point or something else depends on the value
of @code{magit-branch-adjust-remote-upstream-alist}.
+@item @kbd{b s} (@code{magit-branch-spinoff})
@kindex b s
-@cindex magit-branch-spinoff
-@item @kbd{b s} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-spinoff})
-
+@findex magit-branch-spinoff
This command creates and checks out a new branch starting at and
tracking the current branch. That branch in turn is reset to the
last commit it shares with its upstream. If the current branch has
@@ -6727,18 +6161,16 @@ matter, all commits between FROM and @code{HEAD} are
moved to the new
branch. If FROM is not reachable from @code{HEAD} or is reachable from the
source branch's upstream, then an error is raised.
+@item @kbd{b S} (@code{magit-branch-spinout})
@kindex b S
-@cindex magit-branch-spinout
-@item @kbd{b S} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-spinout})
-
+@findex magit-branch-spinout
This command behaves like @code{magit-branch-spinoff}, except that it does
not change the current branch. If there are any uncommitted changes,
then it behaves exactly like @code{magit-branch-spinoff}.
+@item @kbd{b x} (@code{magit-branch-reset})
@kindex b x
-@cindex magit-branch-reset
-@item @kbd{b x} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-reset})
-
+@findex magit-branch-reset
This command resets a branch, defaulting to the branch at point, to
the tip of another branch or any other commit.
@@ -6753,33 +6185,28 @@ When resetting to another branch and a prefix argument
is used, then
the target branch is set as the upstream of the branch that is being
reset.
+@item @kbd{b k} (@code{magit-branch-delete})
@kindex b k
-@cindex magit-branch-delete
-@item @kbd{b k} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-delete})
-
+@findex magit-branch-delete
Delete one or multiple branches. If the region marks multiple
branches, then offer to delete those. Otherwise, prompt for a single
branch to be deleted, defaulting to the branch at point.
+@item @kbd{b r} (@code{magit-branch-rename})
@kindex b r
-@cindex magit-branch-rename
-@item @kbd{b r} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-rename})
-
+@findex magit-branch-rename
Rename a branch. The branch and the new name are read in the
minibuffer. With prefix argument the branch is renamed even if that
name conflicts with an existing branch.
-
@end table
@defopt magit-branch-read-upstream-first
-
When creating a branch, whether to read the upstream branch before
the name of the branch that is to be created. The default is @code{t},
and I recommend you leave it at that.
@end defopt
@defopt magit-branch-prefer-remote-upstream
-
This option specifies whether remote upstreams are favored over
local upstreams when creating new branches.
@@ -6829,7 +6256,6 @@ prefer the former, then you should add branches such as
@code{master},
@end defopt
@defopt magit-branch-adjust-remote-upstream-alist
-
The value of this option is an alist of branches to be used as
the upstream when branching a remote branch.
@@ -6891,16 +6317,12 @@ you should also account for other common names:
("master" . ("main" "master" "next" "maint")))
@end lisp
-@cindex magit-branch-orphan
@deffn Command magit-branch-orphan
-
This command creates and checks out a new orphan branch with
contents from a given revision.
@end deffn
-@cindex magit-branch-or-checkout
@deffn Command magit-branch-or-checkout
-
This command is a hybrid between @code{magit-checkout} and
@code{magit-branch-and-checkout} and is intended as a replacement for the
former in @code{magit-branch}.
@@ -6930,31 +6352,26 @@ These variables can be set from the transient prefix
command
@code{magit-branch}. See @ref{Branch Commands}.
@defvar branch.NAME.merge
-
Together with @code{branch.NAME.remote} this variable defines the upstream
branch of the local branch named NAME@. The value of this variable
is the full reference of the upstream @emph{branch}.
@end defvar
@defvar branch.NAME.remote
-
Together with @code{branch.NAME.merge} this variable defines the upstream
branch of the local branch named NAME@. The value of this variable
is the name of the upstream @emph{remote}.
@end defvar
@defvar branch.NAME.rebase
-
This variable controls whether pulling into the branch named NAME is
done by rebasing or by merging the fetched branch.
@itemize
@item
When @code{true} then pulling is done by rebasing.
-
@item
When @code{false} then pulling is done by merging.
-
@item
When undefined then the value of @code{pull.rebase} is used. The default
of that variable is @code{false}.
@@ -6962,7 +6379,6 @@ of that variable is @code{false}.
@end defvar
@defvar branch.NAME.pushRemote
-
This variable specifies the remote that the branch named NAME is
usually pushed to. The value has to be the name of an existing
remote.
@@ -6977,7 +6393,6 @@ is undefined.
@end defvar
@defvar branch.NAME.description
-
This variable can be used to describe the branch named NAME@. That
description is used e.g. when turning the branch into a series of
patches.
@@ -6987,14 +6402,12 @@ The following variables specify defaults which are used
if the above
branch-specific variables are not set.
@defvar pull.rebase
-
This variable specifies whether pulling is done by rebasing or by
merging. It can be overwritten using @code{branch.NAME.rebase}.
@itemize
@item
When @code{true} then pulling is done by rebasing.
-
@item
When @code{false} (the default) then pulling is done by merging.
@end itemize
@@ -7006,7 +6419,6 @@ should consider setting this to @code{true}, and
@code{branch.master.rebase} to
@end defvar
@defvar remote.pushDefault
-
This variable specifies what remote the local branches are usually
pushed to. This can be overwritten per branch using
@code{branch.NAME.pushRemote}.
@@ -7017,7 +6429,6 @@ control whether the various branch-specific variables are
automatically set at this time.
@defvar branch.autoSetupMerge
-
This variable specifies under what circumstances creating a branch
NAME should result in the variables @code{branch.NAME.merge} and
@code{branch.NAME.remote} being set according to the starting point used to
@@ -7028,18 +6439,15 @@ variables are never set.
@item
When @code{always} then the variables are set regardless of whether the
starting point is a local or a remote branch.
-
@item
When @code{true} (the default) then the variables are set when the starting
point is a remote branch, but not when it is a local branch.
-
@item
When @code{false} then the variables are never set.
@end itemize
@end defvar
@defvar branch.autoSetupRebase
-
This variable specifies whether creating a branch NAME should result
in the variable @code{branch.NAME.rebase} being set to @code{true}.
@@ -7047,15 +6455,12 @@ in the variable @code{branch.NAME.rebase} being set to
@code{true}.
@item
When @code{always} then the variable is set regardless of whether the
starting point is a local or a remote branch.
-
@item
When @code{local} then the variable are set when the starting point is a
local branch, but not when it is a remote branch.
-
@item
When @code{remote} then the variable are set when the starting point is a
remote branch, but not when it is a local branch.
-
@item
When @code{never} (the default) then the variable is never set.
@end itemize
@@ -7110,7 +6515,6 @@ the git-checkout(1) manpage.
and @ref{Pushing}.
@defopt magit-prefer-remote-upstream
-
This option controls whether commands that read a branch from the
user and then set it as the upstream branch, offer a local or a
remote branch as default completion candidate, when they have the
@@ -7127,9 +6531,7 @@ the upstream and many which create new branches.
These commands are not available from the transient @code{magit-branch} by
default.
-@cindex magit-branch-shelve
@deffn Command magit-branch-shelve
-
This command shelves a branch. This is done by deleting the branch,
and creating a new reference "refs/shelved/BRANCH-NAME" pointing at
the same commit as the branch pointed at. If the deleted branch had
@@ -7139,9 +6541,7 @@ This is useful if you want to move a branch out of sight,
but are
not ready to completely discard it yet.
@end deffn
-@cindex magit-branch-unshelve
@deffn Command magit-branch-unshelve
-
This command unshelves a branch that was previously shelved using
@code{magit-branch-shelve}. This is done by deleting the reference
"refs/shelved/BRANCH-NAME" and creating a branch "BRANCH-NAME"
@@ -7169,10 +6569,9 @@ the git-merge(1) manpage.
merge conflicts see the next section.
@table @asis
+@item @kbd{m} (@code{magit-merge})
@kindex m
-@cindex magit-merge
-@item @kbd{m} @tie{}@tie{}@tie{}@tie{}(@code{magit-merge})
-
+@findex magit-merge
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
@@ -7182,10 +6581,9 @@ When no merge is in progress, then the transient
features the
following suffix commands.
@table @asis
+@item @kbd{m m} (@code{magit-merge-plain})
@kindex m m
-@cindex magit-merge-plain
-@item @kbd{m m} @tie{}@tie{}@tie{}@tie{}(@code{magit-merge-plain})
-
+@findex magit-merge-plain
This command merges another branch or an arbitrary revision into the
current branch. The branch or revision to be merged is read in the
minibuffer and defaults to the branch at point.
@@ -7197,28 +6595,25 @@ created. With a prefix argument this does not actually
create the
merge commit, which makes it possible to inspect how conflicts were
resolved and to adjust the commit message.
+@item @kbd{m e} (@code{magit-merge-editmsg})
@kindex m e
-@cindex magit-merge-editmsg
-@item @kbd{m e} @tie{}@tie{}@tie{}@tie{}(@code{magit-merge-editmsg})
-
+@findex magit-merge-editmsg
This command merges another branch or an arbitrary revision into the
current branch and opens a commit message buffer, so that the user
can make adjustments. The commit is not actually created until the
user finishes with @code{C-c C-c}.
+@item @kbd{m n} (@code{magit-merge-nocommit})
@kindex m n
-@cindex magit-merge-nocommit
-@item @kbd{m n} @tie{}@tie{}@tie{}@tie{}(@code{magit-merge-nocommit})
-
+@findex magit-merge-nocommit
This command merges another branch or an arbitrary revision into the
current branch, but does not actually create the merge commit. The
user can then further adjust the merge, even when automatic conflict
resolution succeeded and/or adjust the commit message.
+@item @kbd{m a} (@code{magit-merge-absorb})
@kindex m a
-@cindex magit-merge-absorb
-@item @kbd{m a} @tie{}@tie{}@tie{}@tie{}(@code{magit-merge-absorb})
-
+@findex magit-merge-absorb
This command merges another local branch into the current branch and
then removes the former.
@@ -7229,10 +6624,9 @@ stuck on some obsolete version of the commits that are
being merged.
Finally, if @code{magit-branch-pull-request} was used to create the merged
branch, then the respective remote branch is also removed.
+@item @kbd{m i} (@code{magit-merge-into})
@kindex m i
-@cindex magit-merge-into
-@item @kbd{m i} @tie{}@tie{}@tie{}@tie{}(@code{magit-merge-into})
-
+@findex magit-merge-into
This command merges the current branch into another local branch and
then removes the former. The latter becomes the new current branch.
@@ -7243,20 +6637,18 @@ stuck on some obsolete version of the commits that are
being merged.
Finally, if @code{magit-branch-pull-request} was used to create the merged
branch, then the respective remote branch is also removed.
+@item @kbd{m s} (@code{magit-merge-squash})
@kindex m s
-@cindex magit-merge-squash
-@item @kbd{m s} @tie{}@tie{}@tie{}@tie{}(@code{magit-merge-squash})
-
+@findex magit-merge-squash
This command squashes the changes introduced by another branch or an
arbitrary revision into the current branch. This only applies the
changes made by the squashed commits. No information is preserved
that would allow creating an actual merge commit. Instead of this
command you should probably use a command from the apply transient.
+@item @kbd{m p} (@code{magit-merge-preview})
@kindex m p
-@cindex magit-merge-preview
-@item @kbd{m p} @tie{}@tie{}@tie{}@tie{}(@code{magit-merge-preview})
-
+@findex magit-merge-preview
This command shows a preview of merging another branch or an
arbitrary revision into the current branch.
@end table
@@ -7265,17 +6657,15 @@ When a merge is in progress, then the transient instead
features the
following suffix commands.
@table @asis
+@item @kbd{m m} (@code{magit-merge})
@kindex m m
-@cindex magit-merge
-@item @kbd{m m} @tie{}@tie{}@tie{}@tie{}(@code{magit-merge})
-
+@findex magit-merge
After the user resolved conflicts, this command proceeds with the
merge. If some conflicts weren't resolved, then this command fails.
+@item @kbd{m a} (@code{magit-merge-abort})
@kindex m a
-@cindex magit-merge-abort
-@item @kbd{m a} @tie{}@tie{}@tie{}@tie{}(@code{magit-merge-abort})
-
+@findex magit-merge-abort
This command aborts the current merge operation.
@end table
@@ -7419,10 +6809,9 @@ the git-rebase(1) manpage.
conflicts that occur during rebases see the preceding section.
@table @asis
+@item @kbd{r} (@code{magit-rebase})
@kindex r
-@cindex magit-rebase
-@item @kbd{r} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase})
-
+@findex magit-rebase
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
@@ -7441,38 +6830,34 @@ See @ref{Information About In-Progress Rebase}.
For information about the upstream and the push-remote, see @ref{The Two
Remotes}.
@table @asis
+@item @kbd{r p} (@code{magit-rebase-onto-pushremote})
@kindex r p
-@cindex magit-rebase-onto-pushremote
-@item @kbd{r p} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-onto-pushremote})
-
+@findex magit-rebase-onto-pushremote
This command rebases the current branch onto its push-remote.
With a prefix argument or when the push-remote is either not
configured or unusable, then let the user first configure the
push-remote.
+@item @kbd{r u} (@code{magit-rebase-onto-upstream})
@kindex r u
-@cindex magit-rebase-onto-upstream
-@item @kbd{r u} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-onto-upstream})
-
+@findex magit-rebase-onto-upstream
This command rebases the current branch onto its upstream branch.
With a prefix argument or when the upstream is either not
configured or unusable, then let the user first configure
the upstream.
+@item @kbd{r e} (@code{magit-rebase-branch})
@kindex r e
-@cindex magit-rebase-branch
-@item @kbd{r e} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-branch})
-
+@findex magit-rebase-branch
This command rebases the current branch onto a branch read in the
minibuffer. All commits that are reachable from head but not from
the selected branch TARGET are being rebased.
+@item @kbd{r s} (@code{magit-rebase-subset})
@kindex r s
-@cindex magit-rebase-subset
-@item @kbd{r s} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-subset})
-
+@findex magit-rebase-subset
This command starts a non-interactive rebase sequence to transfer
commits from START to @code{HEAD} onto NEWBASE@. START has to be selected
from a list of recent commits.
@@ -7503,37 +6888,32 @@ following commands as they always use that argument
anyway, even if it
is not enabled in the transient.
@table @asis
+@item @kbd{r i} (@code{magit-rebase-interactive})
@kindex r i
-@cindex magit-rebase-interactive
-@item @kbd{r i} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-interactive})
-
+@findex magit-rebase-interactive
This command starts an interactive rebase sequence.
+@item @kbd{r f} (@code{magit-rebase-autosquash})
@kindex r f
-@cindex magit-rebase-autosquash
-@item @kbd{r f} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-autosquash})
-
+@findex magit-rebase-autosquash
This command combines squash and fixup commits with their intended
targets.
+@item @kbd{r m} (@code{magit-rebase-edit-commit})
@kindex r m
-@cindex magit-rebase-edit-commit
-@item @kbd{r m} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-edit-commit})
-
+@findex magit-rebase-edit-commit
This command starts an interactive rebase sequence that lets the
user edit a single older commit.
+@item @kbd{r w} (@code{magit-rebase-reword-commit})
@kindex r w
-@cindex magit-rebase-reword-commit
-@item @kbd{r w} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-reword-commit})
-
+@findex magit-rebase-reword-commit
This command starts an interactive rebase sequence that lets the
user reword a single older commit.
+@item @kbd{r k} (@code{magit-rebase-remove-commit})
@kindex r k
-@cindex magit-rebase-remove-commit
-@item @kbd{r k} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-remove-commit})
-
+@findex magit-rebase-remove-commit
This command removes a single older commit using rebase.
@end table
@@ -7541,33 +6921,29 @@ When a rebase is in progress, then the transient
instead features
the following suffix commands.
@table @asis
+@item @kbd{r r} (@code{magit-rebase-continue})
@kindex r r
-@cindex magit-rebase-continue
-@item @kbd{r r} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-continue})
-
+@findex magit-rebase-continue
This command restart the current rebasing operation.
In some cases this pops up a commit message buffer for you do edit.
With a prefix argument the old message is reused as-is.
+@item @kbd{r s} (@code{magit-rebase-skip})
@kindex r s
-@cindex magit-rebase-skip
-@item @kbd{r s} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-skip})
-
+@findex magit-rebase-skip
This command skips the current commit and restarts the current
rebase operation.
+@item @kbd{r e} (@code{magit-rebase-edit})
@kindex r e
-@cindex magit-rebase-edit
-@item @kbd{r e} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-edit})
-
+@findex magit-rebase-edit
This command lets the user edit the todo list of the current rebase
operation.
+@item @kbd{r a} (@code{magit-rebase-abort})
@kindex r a
-@cindex magit-rebase-abort
-@item @kbd{r a} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-abort})
-
+@findex magit-rebase-abort
This command aborts the current rebase operation, restoring the
original branch.
@end table
@@ -7581,110 +6957,94 @@ original branch.
@subsection Editing Rebase Sequences
@table @asis
+@item @kbd{C-c C-c} (@code{with-editor-finish})
@kindex C-c C-c
-@cindex with-editor-finish
-@item @kbd{C-c C-c} @tie{}@tie{}@tie{}@tie{}(@code{with-editor-finish})
-
+@findex with-editor-finish
Finish the current editing session by returning with exit code 0.
Git then uses the rebase instructions it finds in the file.
+@item @kbd{C-c C-k} (@code{with-editor-cancel})
@kindex C-c C-k
-@cindex with-editor-cancel
-@item @kbd{C-c C-k} @tie{}@tie{}@tie{}@tie{}(@code{with-editor-cancel})
-
+@findex with-editor-cancel
Cancel the current editing session by returning with exit code 1.
Git then forgoes starting the rebase sequence.
+@item @kbd{@key{RET}} (@code{git-rebase-show-commit})
@kindex RET
-@cindex git-rebase-show-commit
-@item @kbd{RET} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-show-commit})
-
+@findex git-rebase-show-commit
Show the commit on the current line in another buffer and select
that buffer.
+@item @kbd{@key{SPC}} (@code{git-rebase-show-or-scroll-up})
@kindex SPC
-@cindex git-rebase-show-or-scroll-up
-@item @kbd{SPC} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-show-or-scroll-up})
-
+@findex git-rebase-show-or-scroll-up
Show the commit on the current line in another buffer without
selecting that buffer. If the revision buffer is already visible in
another window of the current frame, then instead scroll that window
up.
+@item @kbd{DEL} (@code{git-rebase-show-or-scroll-down})
@kindex DEL
-@cindex git-rebase-show-or-scroll-down
-@item @kbd{DEL} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-show-or-scroll-down})
-
+@findex git-rebase-show-or-scroll-down
Show the commit on the current line in another buffer without
selecting that buffer. If the revision buffer is already visible in
another window of the current frame, then instead scroll that window
down.
+@item @kbd{p} (@code{git-rebase-backward-line})
@kindex p
-@cindex git-rebase-backward-line
-@item @kbd{p} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-backward-line})
-
+@findex git-rebase-backward-line
Move to previous line.
+@item @kbd{n} (@code{forward-line})
@kindex n
-@cindex forward-line
-@item @kbd{n} @tie{}@tie{}@tie{}@tie{}(@code{forward-line})
-
+@findex forward-line
Move to next line.
+@item @kbd{M-p} (@code{git-rebase-move-line-up})
@kindex M-p
-@cindex git-rebase-move-line-up
-@item @kbd{M-p} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-move-line-up})
-
+@findex git-rebase-move-line-up
Move the current commit (or command) up.
+@item @kbd{M-n} (@code{git-rebase-move-line-down})
@kindex M-n
-@cindex git-rebase-move-line-down
-@item @kbd{M-n} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-move-line-down})
-
+@findex git-rebase-move-line-down
Move the current commit (or command) down.
+@item @kbd{r} (@code{git-rebase-reword})
@kindex r
-@cindex git-rebase-reword
-@item @kbd{r} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-reword})
-
+@findex git-rebase-reword
Edit message of commit on current line.
+@item @kbd{e} (@code{git-rebase-edit})
@kindex e
-@cindex git-rebase-edit
-@item @kbd{e} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-edit})
-
+@findex git-rebase-edit
Stop at the commit on the current line.
+@item @kbd{s} (@code{git-rebase-squash})
@kindex s
-@cindex git-rebase-squash
-@item @kbd{s} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-squash})
-
+@findex git-rebase-squash
Meld commit on current line into previous commit, and edit message.
+@item @kbd{f} (@code{git-rebase-fixup})
@kindex f
-@cindex git-rebase-fixup
-@item @kbd{f} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-fixup})
-
+@findex git-rebase-fixup
Meld commit on current line into previous commit, discarding the
current commit's message.
+@item @kbd{k} (@code{git-rebase-kill-line})
@kindex k
-@cindex git-rebase-kill-line
-@item @kbd{k} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-kill-line})
-
+@findex git-rebase-kill-line
Kill the current action line.
+@item @kbd{c} (@code{git-rebase-pick})
@kindex c
-@cindex git-rebase-pick
-@item @kbd{c} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-pick})
-
+@findex git-rebase-pick
Use commit on current line.
+@item @kbd{x} (@code{git-rebase-exec})
@kindex x
-@cindex git-rebase-exec
-@item @kbd{x} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-exec})
-
+@findex git-rebase-exec
Insert a shell command to be run after the proceeding commit.
If there already is such a command on the current line, then edit
@@ -7692,40 +7052,33 @@ that instead. With a prefix argument insert a new
command even when
there already is one on the current line. With empty input remove
the command on the current line, if any.
+@item @kbd{b} (@code{git-rebase-break})
@kindex b
-@cindex git-rebase-break
-@item @kbd{b} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-break})
-
+@findex git-rebase-break
Insert a break action before the current line, instructing Git to
return control to the user.
+@item @kbd{y} (@code{git-rebase-insert})
@kindex y
-@cindex git-rebase-insert
-@item @kbd{y} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-insert})
-
+@findex git-rebase-insert
Read an arbitrary commit and insert it below current line.
+@item @kbd{C-x u} (@code{git-rebase-undo})
@kindex C-x u
-@cindex git-rebase-undo
-@item @kbd{C-x u} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-undo})
-
+@findex git-rebase-undo
Undo some previous changes. Like @code{undo} but works in read-only
buffers.
-
@end table
@defopt git-rebase-auto-advance
-
Whether to move to next line after changing a line.
@end defopt
@defopt git-rebase-show-instructions
-
Whether to show usage instructions inside the rebase buffer.
@end defopt
@defopt git-rebase-confirm-cancel
-
Whether confirmation is required to cancel.
@end defopt
@@ -7734,33 +7087,29 @@ sequence will include a few other types of actions and
the following
commands become relevant.
@table @asis
+@item @kbd{l} (@code{git-rebase-label})
@kindex l
-@cindex git-rebase-label
-@item @kbd{l} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-label})
-
+@findex git-rebase-label
This commands inserts a label action or edits the one at point.
+@item @kbd{t} (@code{git-rebase-reset})
@kindex t
-@cindex git-rebase-reset
-@item @kbd{t} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-reset})
-
+@findex git-rebase-reset
This command inserts a reset action or edits the one at point. The
prompt will offer the labels that are currently present in the
buffer.
+@item @kbd{MM} (@code{git-rebase-merge})
@kindex MM
-@cindex git-rebase-merge
-@item @kbd{MM} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-merge})
-
+@findex git-rebase-merge
The command inserts a merge action or edits the one at point. The
prompt will offer the labels that are currently present in the
buffer. Specifying a message to reuse via @code{-c} or @code{-C} is not
supported; an editor will always be invoked for the merge.
+@item @kbd{Mt} (@code{git-rebase-merge-toggle-editmsg})
@kindex Mt
-@cindex git-rebase-merge-toggle-editmsg
-@item @kbd{Mt} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-merge-toggle-editmsg})
-
+@findex git-rebase-merge-toggle-editmsg
This command toggles between the @code{-C} and @code{-c} options of the merge
action at point. These options both specify a commit whose message
should be reused. The lower-case variant instructs Git to invoke
@@ -7793,15 +7142,12 @@ The following colors are used:
@item
Yellow commits have not been applied yet.
-
@item
Gray commits have already been applied.
-
@item
The blue commit is the @code{HEAD} commit.
-
@item
The green commit is the commit the rebase sequence stopped at. If
this is the same commit as @code{HEAD} (e.g. because you haven't done
@@ -7810,7 +7156,6 @@ shown in blue, not green). There can only be a green
@strong{and} a blue
commit at the same time, if you create one or more new commits after
rebase stops at a commit.
-
@item
Red commits have been dropped. They are shown for reference only,
e.g. to make it easier to diff.
@@ -7827,7 +7172,6 @@ been applied yet. These words have the same meaning here
as they do
in the buffer used to edit the rebase sequence. See @ref{Editing Rebase
Sequences}. When the @code{--rebase-merges} option was specified,
@code{reset}, @code{label}, and @code{merge} lines may also be present.
-
@item
Commits prefixed with @code{done} and @code{onto} have already been applied.
It is possible for such a commit to be the @code{HEAD}, in which case it
@@ -7840,14 +7184,12 @@ the other commits are being re-applied. This commit
itself did
not have to be re-applied, it is the commit rebase did rewind to
before starting to re-apply other commits.
-
@item
Commits prefixed with @code{done} have already been re-applied. This
includes commits that have been re-applied but also new commits
that you have created during the rebase.
@end itemize
-
@item
All other commits, those not prefixed with any of the above words,
are in some way related to the commit at which rebase stopped.
@@ -7878,7 +7220,6 @@ applied using several new commits. This commit is no
longer
reachable from @code{HEAD}, and it also isn't one of the commits that
will be applied when resuming the session.
-
@item
When a commit is prefixed with @code{join}, then that indicates that the
rebase sequence stopped at that commit due to a conflict - you now
@@ -7889,7 +7230,6 @@ conflict markers), the commit itself has not actually
been applied
yet (it isn't the @code{HEAD}). So it is shown in yellow, like the other
commits that still have to be applied.
-
@item
When a commit is prefixed with @code{stop} or a @emph{blue} or @emph{green}
@code{same}, then
that indicates that rebase stopped at this commit, that it is
@@ -7903,7 +7243,6 @@ rebase stopped at that commit because you requested that
earlier, and its patch-id is unchanged. It might even still be
the exact same commit.
-
@item
When a commit is prefixed with a @emph{blue} or @emph{green} @code{same}, then
that
indicates that while its tree or hash changed, its patch-id did
@@ -7913,7 +7252,6 @@ other commit have been created since (but before
continuing the
rebase).
@end itemize
-
@item
When a commit is prefixed with @code{goal}, a @emph{yellow} @code{same,} or
@code{work}, then
that indicates that rebase applied that commit but that you then
@@ -7931,7 +7269,6 @@ committing the index, or by staging all changes and then
committing that. This is the case when the original tree still
exists in the index or worktree in untainted form.
-
@item
When a commit is prefixed with a yellow @code{same}, then that
indicates that it is no longer possible to create a commit with
@@ -7941,7 +7278,6 @@ created a new commit with other changes, but the changes
from
the original commit still exist in the index or working tree in
untainted form.
-
@item
When a commit is prefixed with @code{work}, then that indicates that
you reset @code{HEAD} to an earlier commit, and that there are some
@@ -7951,7 +7287,6 @@ to create a new commit with the same tree or at least the
same
patch-id because you have already made other changes.
@end itemize
-
@item
When a commit is prefixed with @code{poof} or @code{gone}, then that indicates
that rebase applied that commit but that you then reset @code{HEAD} to an
@@ -7965,7 +7300,6 @@ is no longer reachable from @code{HEAD}, but that it has
been replaced
with one or more commits, which together have the exact same
effect.
-
@item
When a commit is prefixed with @code{gone}, then that indicates that it
is no longer reachable from @code{HEAD} and that we also cannot
@@ -8003,10 +7337,9 @@ the git-cherry-pick(1) manpage.
@end iftex
@table @asis
+@item @kbd{A} (@code{magit-cherry-pick})
@kindex A
-@cindex magit-cherry-pick
-@item @kbd{A} @tie{}@tie{}@tie{}@tie{}(@code{magit-cherry-pick})
-
+@findex magit-cherry-pick
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
@@ -8016,19 +7349,17 @@ When no cherry-pick or revert is in progress, then the
transient
features the following suffix commands.
@table @asis
+@item @kbd{A A} (@code{magit-cherry-copy})
@kindex A A
-@cindex magit-cherry-copy
-@item @kbd{A A} @tie{}@tie{}@tie{}@tie{}(@code{magit-cherry-copy})
-
+@findex magit-cherry-copy
This command copies COMMITS from another branch onto the current
branch. If the region selects multiple commits, then those are
copied, without prompting. Otherwise the user is prompted for a
commit or range, defaulting to the commit at point.
+@item @kbd{A a} (@code{magit-cherry-apply})
@kindex A a
-@cindex magit-cherry-apply
-@item @kbd{A a} @tie{}@tie{}@tie{}@tie{}(@code{magit-cherry-apply})
-
+@findex magit-cherry-apply
This command applies the changes in COMMITS from another branch onto
the current branch. If the region selects multiple commits, then
those are used, without prompting. Otherwise the user is prompted
@@ -8047,10 +7378,9 @@ only have to resolve the conflicts but also finish the
process the
same way you would have to if these commands didn't exist at all.
@table @asis
+@item @kbd{A h} (@code{magit-cherry-harvest})
@kindex A h
-@cindex magit-cherry-harvest
-@item @kbd{A h} @tie{}@tie{}@tie{}@tie{}(@code{magit-cherry-harvest})
-
+@findex magit-cherry-harvest
This command moves the selected COMMITS that must be located on
another BRANCH onto the current branch instead, removing them from
the former. When this command succeeds, then the same branch is
@@ -8061,10 +7391,9 @@ other branch can lead to conflicts. When that happens,
then this
command stops and you have to resolve the conflicts and then finish
the process manually.
+@item @kbd{A d} (@code{magit-cherry-donate})
@kindex A d
-@cindex magit-cherry-donate
-@item @kbd{A d} @tie{}@tie{}@tie{}@tie{}(@code{magit-cherry-donate})
-
+@findex magit-cherry-donate
This command moves the selected COMMITS from the current branch onto
another existing BRANCH, removing them from the former. When this
command succeeds, then the same branch is current as before. @code{HEAD}
@@ -8075,10 +7404,9 @@ current branch can lead to conflicts. When that
happens, then this
command stops and you have to resolve the conflicts and then finish
the process manually.
+@item @kbd{A n} (@code{magit-cherry-spinout})
@kindex A n
-@cindex magit-cherry-spinout
-@item @kbd{A n} @tie{}@tie{}@tie{}@tie{}(@code{magit-cherry-spinout})
-
+@findex magit-cherry-spinout
This command moves the selected COMMITS from the current branch onto
a new branch BRANCH, removing them from the former. When this
command succeeds, then the same branch is current as before.
@@ -8088,10 +7416,9 @@ current branch can lead to conflicts. When that
happens, then this
command stops and you have to resolve the conflicts and then finish
the process manually.
+@item @kbd{A s} (@code{magit-cherry-spinoff})
@kindex A s
-@cindex magit-cherry-spinoff
-@item @kbd{A s} @tie{}@tie{}@tie{}@tie{}(@code{magit-cherry-spinoff})
-
+@findex magit-cherry-spinoff
This command moves the selected COMMITS from the current branch onto
a new branch BRANCH, removing them from the former. When this
command succeeds, then the new branch is checked out.
@@ -8106,22 +7433,19 @@ When a cherry-pick or revert is in progress, then the
transient
instead features the following suffix commands.
@table @asis
+@item @kbd{A A} (@code{magit-sequence-continue})
@kindex A A
-@cindex magit-sequence-continue
-@item @kbd{A A} @tie{}@tie{}@tie{}@tie{}(@code{magit-sequence-continue})
-
+@findex magit-sequence-continue
Resume the current cherry-pick or revert sequence.
+@item @kbd{A s} (@code{magit-sequence-skip})
@kindex A s
-@cindex magit-sequence-skip
-@item @kbd{A s} @tie{}@tie{}@tie{}@tie{}(@code{magit-sequence-skip})
-
+@findex magit-sequence-skip
Skip the stopped at commit during a cherry-pick or revert sequence.
+@item @kbd{A a} (@code{magit-sequence-abort})
@kindex A a
-@cindex magit-sequence-abort
-@item @kbd{A a} @tie{}@tie{}@tie{}@tie{}(@code{magit-sequence-abort})
-
+@findex magit-sequence-abort
Abort the current cherry-pick or revert sequence. This discards all
changes made since the sequence started.
@end table
@@ -8134,10 +7458,9 @@ changes made since the sequence started.
@subsection Reverting
@table @asis
+@item @kbd{V} (@code{magit-revert})
@kindex V
-@cindex magit-revert
-@item @kbd{V} @tie{}@tie{}@tie{}@tie{}(@code{magit-revert})
-
+@findex magit-revert
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
@@ -8147,18 +7470,16 @@ When no cherry-pick or revert is in progress, then the
transient
features the following suffix commands.
@table @asis
+@item @kbd{V V} (@code{magit-revert-and-commit})
@kindex V V
-@cindex magit-revert-and-commit
-@item @kbd{V V} @tie{}@tie{}@tie{}@tie{}(@code{magit-revert-and-commit})
-
+@findex magit-revert-and-commit
Revert a commit by creating a new commit. Prompt for a commit,
defaulting to the commit at point. If the region selects multiple
commits, then revert all of them, without prompting.
+@item @kbd{V v} (@code{magit-revert-no-commit})
@kindex V v
-@cindex magit-revert-no-commit
-@item @kbd{V v} @tie{}@tie{}@tie{}@tie{}(@code{magit-revert-no-commit})
-
+@findex magit-revert-no-commit
Revert a commit by applying it in reverse to the working tree.
Prompt for a commit, defaulting to the commit at point. If the
region selects multiple commits, then revert all of them, without
@@ -8169,22 +7490,19 @@ When a cherry-pick or revert is in progress, then the
transient
instead features the following suffix commands.
@table @asis
+@item @kbd{V A} (@code{magit-sequence-continue})
@kindex V A
-@cindex magit-sequence-continue
-@item @kbd{V A} @tie{}@tie{}@tie{}@tie{}(@code{magit-sequence-continue})
-
+@findex magit-sequence-continue
Resume the current cherry-pick or revert sequence.
+@item @kbd{V s} (@code{magit-sequence-skip})
@kindex V s
-@cindex magit-sequence-skip
-@item @kbd{V s} @tie{}@tie{}@tie{}@tie{}(@code{magit-sequence-skip})
-
+@findex magit-sequence-skip
Skip the stopped at commit during a cherry-pick or revert sequence.
+@item @kbd{V a} (@code{magit-sequence-abort})
@kindex V a
-@cindex magit-sequence-abort
-@item @kbd{V a} @tie{}@tie{}@tie{}@tie{}(@code{magit-sequence-abort})
-
+@findex magit-sequence-abort
Abort the current cherry-pick or revert sequence. This discards all
changes made since the sequence started.
@end table
@@ -8206,65 +7524,57 @@ the git-reset(1) manpage.
@end iftex
@table @asis
+@item @kbd{x} (@code{magit-reset-quickly})
@kindex x
-@cindex magit-reset-quickly
-@item @kbd{x} @tie{}@tie{}@tie{}@tie{}(@code{magit-reset-quickly})
-
+@findex magit-reset-quickly
Reset the @code{HEAD} and index to some commit read from the user and
defaulting to the commit at point, and possibly also reset the
working tree. With a prefix argument reset the working tree
otherwise don't.
+@item @kbd{X m} (@code{magit-reset-mixed})
@kindex X m
-@cindex magit-reset-mixed
-@item @kbd{X m} @tie{}@tie{}@tie{}@tie{}(@code{magit-reset-mixed})
-
+@findex magit-reset-mixed
Reset the @code{HEAD} and index to some commit read from the user and
defaulting to the commit at point. The working tree is kept as-is.
+@item @kbd{X s} (@code{magit-reset-soft})
@kindex X s
-@cindex magit-reset-soft
-@item @kbd{X s} @tie{}@tie{}@tie{}@tie{}(@code{magit-reset-soft})
-
+@findex magit-reset-soft
Reset the @code{HEAD} to some commit read from the user and defaulting
to the commit at point. The index and the working tree are kept
as-is.
+@item @kbd{X h} (@code{magit-reset-hard})
@kindex X h
-@cindex magit-reset-hard
-@item @kbd{X h} @tie{}@tie{}@tie{}@tie{}(@code{magit-reset-hard})
-
+@findex magit-reset-hard
Reset the @code{HEAD}, index, and working tree to some commit read from the
user and defaulting to the commit at point.
+@item @kbd{X k} (@code{magit-reset-keep})
@kindex X k
-@cindex magit-reset-keep
-@item @kbd{X k} @tie{}@tie{}@tie{}@tie{}(@code{magit-reset-keep})
-
+@findex magit-reset-keep
Reset the @code{HEAD}, index, and working tree to some commit read from the
user and defaulting to the commit at point. Uncommitted changes are
kept as-is.
+@item @kbd{X i} (@code{magit-reset-index})
@kindex X i
-@cindex magit-reset-index
-@item @kbd{X i} @tie{}@tie{}@tie{}@tie{}(@code{magit-reset-index})
-
+@findex magit-reset-index
Reset the index to some commit read from the user and defaulting to
the commit at point. Keep the @code{HEAD} and working tree as-is, so if
the commit refers to the @code{HEAD}, then this effectively unstages all
changes.
+@item @kbd{X w} (@code{magit-reset-worktree})
@kindex X w
-@cindex magit-reset-worktree
-@item @kbd{X w} @tie{}@tie{}@tie{}@tie{}(@code{magit-reset-worktree})
-
+@findex magit-reset-worktree
Reset the working tree to some commit read from the user and
defaulting to the commit at point. Keep the @code{HEAD} and index as-is.
+@item @kbd{X f} (@code{magit-file-checkout})
@kindex X f
-@cindex magit-file-checkout
-@item @kbd{X f} @tie{}@tie{}@tie{}@tie{}(@code{magit-file-checkout})
-
+@findex magit-file-checkout
Update file in the working tree and index to the contents from a
revision. Both the revision and file are read from the user.
@end table
@@ -8286,140 +7596,121 @@ the git-stash(1) manpage.
@end iftex
@table @asis
+@item @kbd{z} (@code{magit-stash})
@kindex z
-@cindex magit-stash
-@item @kbd{z} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash})
-
+@findex magit-stash
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
+@item @kbd{z z} (@code{magit-stash-both})
@kindex z z
-@cindex magit-stash-both
-@item @kbd{z z} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-both})
-
+@findex magit-stash-both
Create a stash of the index and working tree. Untracked files are
included according to infix arguments. One prefix argument is
equivalent to @code{--include-untracked} while two prefix arguments are
equivalent to @code{--all}.
+@item @kbd{z i} (@code{magit-stash-index})
@kindex z i
-@cindex magit-stash-index
-@item @kbd{z i} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-index})
-
+@findex magit-stash-index
Create a stash of the index only. Unstaged and untracked changes
are not stashed.
+@item @kbd{z w} (@code{magit-stash-worktree})
@kindex z w
-@cindex magit-stash-worktree
-@item @kbd{z w} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-worktree})
-
+@findex magit-stash-worktree
Create a stash of unstaged changes in the working tree. Untracked
files are included according to infix arguments. One prefix
argument is equivalent to @code{--include-untracked} while two prefix
arguments are equivalent to @code{--all}.
+@item @kbd{z x} (@code{magit-stash-keep-index})
@kindex z x
-@cindex magit-stash-keep-index
-@item @kbd{z x} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-keep-index})
-
+@findex magit-stash-keep-index
Create a stash of the index and working tree, keeping index intact.
Untracked files are included according to infix arguments. One
prefix argument is equivalent to @code{--include-untracked} while two
prefix arguments are equivalent to @code{--all}.
+@item @kbd{z Z} (@code{magit-snapshot-both})
@kindex z Z
-@cindex magit-snapshot-both
-@item @kbd{z Z} @tie{}@tie{}@tie{}@tie{}(@code{magit-snapshot-both})
-
+@findex magit-snapshot-both
Create a snapshot of the index and working tree. Untracked files
are included according to infix arguments. One prefix argument is
equivalent to @code{--include-untracked} while two prefix arguments are
equivalent to @code{--all}.
+@item @kbd{z I} (@code{magit-snapshot-index})
@kindex z I
-@cindex magit-snapshot-index
-@item @kbd{z I} @tie{}@tie{}@tie{}@tie{}(@code{magit-snapshot-index})
-
+@findex magit-snapshot-index
Create a snapshot of the index only. Unstaged and untracked changes
are not stashed.
+@item @kbd{z W} (@code{magit-snapshot-worktree})
@kindex z W
-@cindex magit-snapshot-worktree
-@item @kbd{z W} @tie{}@tie{}@tie{}@tie{}(@code{magit-snapshot-worktree})
-
+@findex magit-snapshot-worktree
Create a snapshot of unstaged changes in the working tree.
Untracked files are included according to infix arguments. One
prefix argument is equivalent to @code{--include-untracked} while two
prefix arguments are equivalent to @code{--all}-.
+@item @kbd{z a} (@code{magit-stash-apply})
@kindex z a
-@cindex magit-stash-apply
-@item @kbd{z a} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-apply})
-
+@findex magit-stash-apply
Apply a stash to the working tree. Try to preserve the stash index.
If that fails because there are staged changes, apply without
preserving the stash index.
+@item @kbd{z p} (@code{magit-stash-pop})
@kindex z p
-@cindex magit-stash-pop
-@item @kbd{z p} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-pop})
-
+@findex magit-stash-pop
Apply a stash to the working tree and remove it from stash list.
Try to preserve the stash index. If that fails because there are
staged changes, apply without preserving the stash index and forgo
removing the stash.
+@item @kbd{z k} (@code{magit-stash-drop})
@kindex z k
-@cindex magit-stash-drop
-@item @kbd{z k} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-drop})
-
+@findex magit-stash-drop
Remove a stash from the stash list. When the region is active, offer
to drop all contained stashes.
+@item @kbd{z v} (@code{magit-stash-show})
@kindex z v
-@cindex magit-stash-show
-@item @kbd{z v} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-show})
-
+@findex magit-stash-show
Show all diffs of a stash in a buffer.
+@item @kbd{z b} (@code{magit-stash-branch})
@kindex z b
-@cindex magit-stash-branch
-@item @kbd{z b} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-branch})
-
+@findex magit-stash-branch
Create and checkout a new BRANCH from STASH@. The branch starts at
the commit that was current when the stash was created.
+@item @kbd{z B} (@code{magit-stash-branch-here})
@kindex z B
-@cindex magit-stash-branch-here
-@item @kbd{z B} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-branch-here})
-
+@findex magit-stash-branch-here
Create and checkout a new BRANCH using @code{magit-branch} with the current
branch or @code{HEAD} as the starting-point. Then apply STASH, dropping it
if it applies cleanly.
+@item @kbd{z f} (@code{magit-stash-format-patch})
@kindex z f
-@cindex magit-stash-format-patch
-@item @kbd{z f} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-format-patch})
-
+@findex magit-stash-format-patch
Create a patch from STASH@.
+@item @kbd{k} (@code{magit-stash-clear})
@kindex k
-@cindex magit-stash-clear
-@item @kbd{k} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-clear})
-
+@findex magit-stash-clear
Remove all stashes saved in REF's reflog by deleting REF@.
+@item @kbd{z l} (@code{magit-stash-list})
@kindex z l
-@cindex magit-stash-list
-@item @kbd{z l} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-list})
-
+@findex magit-stash-list
List all stashes in a buffer.
-
@end table
@defopt magit-stashes-margin
-
This option specifies whether the margin is initially shown in
stashes buffers and how it is formatted.
@@ -8428,7 +7719,6 @@ The value has the form @code{(INIT STYLE WIDTH AUTHOR
AUTHOR-WIDTH)}.
@itemize
@item
If INIT is non-nil, then the margin is shown initially.
-
@item
STYLE controls how to format the author or committer date. It can
be one of @code{age} (to show the age of the commit), @code{age-abbreviated}
(to
@@ -8436,15 +7726,12 @@ abbreviate the time unit to a character), or a string
(suitable
for @code{format-time-string}) to show the actual date. Option
@code{magit-log-margin-show-committer-date} controls which date is being
displayed.
-
@item
WIDTH controls the width of the margin. This exists for forward
compatibility and currently the value should not be changed.
-
@item
AUTHOR controls whether the name of the author is also shown by
default.
-
@item
AUTHOR-WIDTH has to be an integer. When the name of the author
is shown, then this specifies how much space is used to do so.
@@ -8493,20 +7780,17 @@ the git-remote(1) manpage.
@end iftex
@table @asis
+@item @kbd{M} (@code{magit-remote})
@kindex M
-@cindex magit-remote
-@item @kbd{M} @tie{}@tie{}@tie{}@tie{}(@code{magit-remote})
-
+@findex magit-remote
This transient prefix command binds the following suffix commands
and displays them in a temporary buffer until a suffix is invoked.
By default it also binds and displays the values of some
remote-related Git variables and allows changing their values.
-
@end table
@defopt magit-remote-direct-configure
-
This option controls whether remote-related Git variables are
accessible directly from the transient @code{magit-remote}.
@@ -8518,10 +7802,9 @@ If @code{nil}, then @code{magit-remote-configure} has to
be used to do so.
@end defopt
@table @asis
+@item @kbd{M C} (@code{magit-remote-configure})
@kindex M C
-@cindex magit-remote-configure
-@item @kbd{M C} @tie{}@tie{}@tie{}@tie{}(@code{magit-remote-configure})
-
+@findex magit-remote-configure
This transient prefix command binds commands that set the value of
remote-related variables and displays them in a temporary buffer
until the transient is exited.
@@ -8539,44 +7822,38 @@ prompts for a remote.
The variables are described in @ref{Remote Git Variables}.
@table @asis
+@item @kbd{M a} (@code{magit-remote-add})
@kindex M a
-@cindex magit-remote-add
-@item @kbd{M a} @tie{}@tie{}@tie{}@tie{}(@code{magit-remote-add})
-
+@findex magit-remote-add
This command add a remote and fetches it. The remote name and url
are read in the minibuffer.
+@item @kbd{M r} (@code{magit-remote-rename})
@kindex M r
-@cindex magit-remote-rename
-@item @kbd{M r} @tie{}@tie{}@tie{}@tie{}(@code{magit-remote-rename})
-
+@findex magit-remote-rename
This command renames a remote. Both the old and the new names are
read in the minibuffer.
+@item @kbd{M u} (@code{magit-remote-set-url})
@kindex M u
-@cindex magit-remote-set-url
-@item @kbd{M u} @tie{}@tie{}@tie{}@tie{}(@code{magit-remote-set-url})
-
+@findex magit-remote-set-url
This command changes the url of a remote. Both the remote and the
new url are read in the minibuffer.
+@item @kbd{M k} (@code{magit-remote-remove})
@kindex M k
-@cindex magit-remote-remove
-@item @kbd{M k} @tie{}@tie{}@tie{}@tie{}(@code{magit-remote-remove})
-
+@findex magit-remote-remove
This command deletes a remote, read in the minibuffer.
+@item @kbd{M p} (@code{magit-remote-prune})
@kindex M p
-@cindex magit-remote-prune
-@item @kbd{M p} @tie{}@tie{}@tie{}@tie{}(@code{magit-remote-prune})
-
+@findex magit-remote-prune
This command removes stale remote-tracking branches for a remote
read in the minibuffer.
+@item @kbd{M P} (@code{magit-remote-prune-refspecs})
@kindex M P
-@cindex magit-remote-prune-refspecs
-@item @kbd{M P} @tie{}@tie{}@tie{}@tie{}(@code{magit-remote-prune-refspecs})
-
+@findex magit-remote-prune-refspecs
This command removes stale refspecs for a remote read in the
minibuffer.
@@ -8592,11 +7869,9 @@ refspec ("+refs/heads/*:refs/remotes/REMOTE/*").
This command also removes the remote-tracking branches that were
created due to the now stale refspecs. Other stale branches are
not removed.
-
@end table
@defopt magit-remote-add-set-remote.pushDefault
-
This option controls whether the user is asked whether they want to
set @code{remote.pushDefault} after adding a remote.
@@ -8616,32 +7891,27 @@ These variables can be set from the transient prefix
command
@code{magit-remote}. See @ref{Remote Commands}.
@defvar remote.NAME.url
-
This variable specifies the url of the remote named NAME@. It can
have multiple values.
@end defvar
@defvar remote.NAME.fetch
-
The refspec used when fetching from the remote named NAME@. It can
have multiple values.
@end defvar
@defvar remote.NAME.pushurl
-
This variable specifies the url used for fetching from the remote
named NAME@. If it is not specified, then @code{remote.NAME.url} is used
instead. It can have multiple values.
@end defvar
@defvar remote.NAME.push
-
The refspec used when pushing to the remote named NAME@. It can
have multiple values.
@end defvar
@defvar remote.NAME.tagOpts
-
This variable specifies what tags are fetched by default. If the
value is @code{--no-tags} then no tags are fetched. If the value is
@code{--tags}, then all tags are fetched. If this variable has no value,
@@ -8667,28 +7937,25 @@ the git-fetch(1) manpage.
push-remote, see @ref{The Two Remotes}.
@table @asis
+@item @kbd{f} (@code{magit-fetch})
@kindex f
-@cindex magit-fetch
-@item @kbd{f} @tie{}@tie{}@tie{}@tie{}(@code{magit-fetch})
-
+@findex magit-fetch
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
+@item @kbd{f p} (@code{magit-fetch-from-pushremote})
@kindex f p
-@cindex magit-fetch-from-pushremote
-@item @kbd{f p} @tie{}@tie{}@tie{}@tie{}(@code{magit-fetch-from-pushremote})
-
+@findex magit-fetch-from-pushremote
This command fetches from the current push-remote.
With a prefix argument or when the push-remote is either not
configured or unusable, then let the user first configure the
push-remote.
+@item @kbd{f u} (@code{magit-fetch-from-upstream})
@kindex f u
-@cindex magit-fetch-from-upstream
-@item @kbd{f u} @tie{}@tie{}@tie{}@tie{}(@code{magit-fetch-from-upstream})
-
+@findex magit-fetch-from-upstream
This command fetch from the upstream of the current branch.
If the upstream is configured for the current branch and names
@@ -8700,43 +7967,36 @@ If no remote can be determined, then this command is
not available
from the @code{magit-fetch} transient prefix and invoking it directly
results in an error.
+@item @kbd{f e} (@code{magit-fetch-other})
@kindex f e
-@cindex magit-fetch-other
-@item @kbd{f e} @tie{}@tie{}@tie{}@tie{}(@code{magit-fetch-other})
-
+@findex magit-fetch-other
This command fetch from a repository read from the minibuffer.
+@item @kbd{f o} (@code{magit-fetch-branch})
@kindex f o
-@cindex magit-fetch-branch
-@item @kbd{f o} @tie{}@tie{}@tie{}@tie{}(@code{magit-fetch-branch})
-
+@findex magit-fetch-branch
This command fetches a branch from a remote, both of which are read
from the minibuffer.
+@item @kbd{f r} (@code{magit-fetch-refspec})
@kindex f r
-@cindex magit-fetch-refspec
-@item @kbd{f r} @tie{}@tie{}@tie{}@tie{}(@code{magit-fetch-refspec})
-
+@findex magit-fetch-refspec
This command fetches from a remote using an explicit refspec, both
of which are read from the minibuffer.
+@item @kbd{f a} (@code{magit-fetch-all})
@kindex f a
-@cindex magit-fetch-all
-@item @kbd{f a} @tie{}@tie{}@tie{}@tie{}(@code{magit-fetch-all})
-
+@findex magit-fetch-all
This command fetches from all remotes.
+@item @kbd{f m} (@code{magit-submodule-fetch})
@kindex f m
-@cindex magit-submodule-fetch
-@item @kbd{f m} @tie{}@tie{}@tie{}@tie{}(@code{magit-submodule-fetch})
-
+@findex magit-submodule-fetch
This command fetches all submodules. With a prefix argument it
fetches all remotes of all submodules.
-
@end table
@defopt magit-pull-or-fetch
-
By default fetch and pull commands are available from separate
transient prefix command. Setting this to @code{t} adds some (but not all)
of the above suffix commands to the @code{magit-pull} transient.
@@ -8770,37 +8030,33 @@ the git-pull(1) manpage.
push-remote, see @ref{The Two Remotes}.
@table @asis
+@item @kbd{F} (@code{magit-pull})
@kindex F
-@cindex magit-pull
-@item @kbd{F} @tie{}@tie{}@tie{}@tie{}(@code{magit-pull})
-
+@findex magit-pull
This transient prefix command binds the following suffix commands
and displays them in a temporary buffer until a suffix is invoked.
+@item @kbd{F p} (@code{magit-pull-from-pushremote})
@kindex F p
-@cindex magit-pull-from-pushremote
-@item @kbd{F p} @tie{}@tie{}@tie{}@tie{}(@code{magit-pull-from-pushremote})
-
+@findex magit-pull-from-pushremote
This command pulls from the push-remote of the current branch.
With a prefix argument or when the push-remote is either not
configured or unusable, then let the user first configure the
push-remote.
+@item @kbd{F u} (@code{magit-pull-from-upstream})
@kindex F u
-@cindex magit-pull-from-upstream
-@item @kbd{F u} @tie{}@tie{}@tie{}@tie{}(@code{magit-pull-from-upstream})
-
+@findex magit-pull-from-upstream
This command pulls from the upstream of the current branch.
With a prefix argument or when the upstream is either not
configured or unusable, then let the user first configure
the upstream.
+@item @kbd{F e} (@code{magit-pull-branch})
@kindex F e
-@cindex magit-pull-branch
-@item @kbd{F e} @tie{}@tie{}@tie{}@tie{}(@code{magit-pull-branch})
-
+@findex magit-pull-branch
This command pulls from a branch read in the minibuffer.
@end table
@@ -8823,52 +8079,46 @@ the git-push(1) manpage.
push-remote, see @ref{The Two Remotes}.
@table @asis
+@item @kbd{P} (@code{magit-push})
@kindex P
-@cindex magit-push
-@item @kbd{P} @tie{}@tie{}@tie{}@tie{}(@code{magit-push})
-
+@findex magit-push
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
+@item @kbd{P p} (@code{magit-push-current-to-pushremote})
@kindex P p
-@cindex magit-push-current-to-pushremote
-@item @kbd{P p}
@tie{}@tie{}@tie{}@tie{}(@code{magit-push-current-to-pushremote})
-
+@findex magit-push-current-to-pushremote
This command pushes the current branch to its push-remote.
With a prefix argument or when the push-remote is either not
configured or unusable, then let the user first configure the
push-remote.
+@item @kbd{P u} (@code{magit-push-current-to-upstream})
@kindex P u
-@cindex magit-push-current-to-upstream
-@item @kbd{P u} @tie{}@tie{}@tie{}@tie{}(@code{magit-push-current-to-upstream})
-
+@findex magit-push-current-to-upstream
This command pushes the current branch to its upstream branch.
With a prefix argument or when the upstream is either not
configured or unusable, then let the user first configure
the upstream.
+@item @kbd{P e} (@code{magit-push-current})
@kindex P e
-@cindex magit-push-current
-@item @kbd{P e} @tie{}@tie{}@tie{}@tie{}(@code{magit-push-current})
-
+@findex magit-push-current
This command pushes the current branch to a branch read in the
minibuffer.
+@item @kbd{P o} (@code{magit-push-other})
@kindex P o
-@cindex magit-push-other
-@item @kbd{P o} @tie{}@tie{}@tie{}@tie{}(@code{magit-push-other})
-
+@findex magit-push-other
This command pushes an arbitrary branch or commit somewhere. Both
the source and the target are read in the minibuffer.
+@item @kbd{P r} (@code{magit-push-refspecs})
@kindex P r
-@cindex magit-push-refspecs
-@item @kbd{P r} @tie{}@tie{}@tie{}@tie{}(@code{magit-push-refspecs})
-
+@findex magit-push-refspecs
This command pushes one or multiple refspecs to a remote, both of
which are read in the minibuffer.
@@ -8876,30 +8126,27 @@ To use multiple refspecs, separate them with commas.
Completion is
only available for the part before the colon, or when no colon is
used.
+@item @kbd{P m} (@code{magit-push-matching})
@kindex P m
-@cindex magit-push-matching
-@item @kbd{P m} @tie{}@tie{}@tie{}@tie{}(@code{magit-push-matching})
-
+@findex magit-push-matching
This command pushes all matching branches to another repository.
If only one remote exists, then push to that. Otherwise prompt for
a remote, offering the remote configured for the current branch as
default.
+@item @kbd{P t} (@code{magit-push-tags})
@kindex P t
-@cindex magit-push-tags
-@item @kbd{P t} @tie{}@tie{}@tie{}@tie{}(@code{magit-push-tags})
-
+@findex magit-push-tags
This command pushes all tags to another repository.
If only one remote exists, then push to that. Otherwise prompt for
a remote, offering the remote configured for the current branch as
default.
+@item @kbd{P T} (@code{magit-push-tag})
@kindex P T
-@cindex magit-push-tag
-@item @kbd{P T} @tie{}@tie{}@tie{}@tie{}(@code{magit-push-tag})
-
+@findex magit-push-tag
This command pushes a tag to another repository.
@end table
@@ -8917,9 +8164,7 @@ Two more push commands exist, which by default are not
available from
the push transient. See their doc-strings for instructions on how to
add them to the transient.
-@cindex magit-push-implicitly args
@deffn Command magit-push-implicitly args
-
This command pushes somewhere without using an explicit refspec.
This command simply runs @code{git push -v [ARGS]}. ARGS are the infix
@@ -8939,9 +8184,7 @@ what this command will do. For example:
@end lisp
@end deffn
-@cindex magit-push-to-remote remote args
@deffn Command magit-push-to-remote remote args
-
This command pushes to the remote REMOTE without using an explicit
refspec. The remote is read in the minibuffer.
@@ -8957,18 +8200,16 @@ behavior depends on at least these Git variables:
@code{push.default},
@section Plain Patches
@table @asis
+@item @kbd{W} (@code{magit-patch})
@kindex W
-@cindex magit-patch
-@item @kbd{W} @tie{}@tie{}@tie{}@tie{}(@code{magit-patch})
-
+@findex magit-patch
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
+@item @kbd{W c} (@code{magit-patch-create})
@kindex W c
-@cindex magit-patch-create
-@item @kbd{W c} @tie{}@tie{}@tie{}@tie{}(@code{magit-patch-create})
-
+@findex magit-patch-create
This command creates patches for a set commits. If the region marks
several commits, then it creates patches for all of them. Otherwise
it functions as a transient prefix command, which features several
@@ -8976,19 +8217,17 @@ infix arguments and binds itself as a suffix command.
When this
command is invoked as a suffix of itself, then it creates a patch
using the specified infix arguments.
+@item @kbd{w a} (@code{magit-patch-apply})
@kindex w a
-@cindex magit-patch-apply
-@item @kbd{w a} @tie{}@tie{}@tie{}@tie{}(@code{magit-patch-apply})
-
+@findex magit-patch-apply
This command applies a patch. This is a transient prefix command,
which features several infix arguments and binds itself as a suffix
command. When this command is invoked as a suffix of itself, then
it applies a patch using the specified infix arguments.
+@item @kbd{W s} (@code{magit-patch-save})
@kindex W s
-@cindex magit-patch-save
-@item @kbd{W s} @tie{}@tie{}@tie{}@tie{}(@code{magit-patch-save})
-
+@findex magit-patch-save
This command creates a patch from the current diff.
Inside @code{magit-diff-mode} or @code{magit-revision-mode} buffers, @code{C-x
C-w} is
@@ -9027,33 +8266,29 @@ the git-apply(1) manpage.
@end iftex
@table @asis
+@item @kbd{w} (@code{magit-am})
@kindex w
-@cindex magit-am
-@item @kbd{w} @tie{}@tie{}@tie{}@tie{}(@code{magit-am})
-
+@findex magit-am
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
+@item @kbd{w w} (@code{magit-am-apply-patches})
@kindex w w
-@cindex magit-am-apply-patches
-@item @kbd{w w} @tie{}@tie{}@tie{}@tie{}(@code{magit-am-apply-patches})
-
+@findex magit-am-apply-patches
This command applies one or more patches. If the region marks
files, then those are applied as patches. Otherwise this command
reads a file-name in the minibuffer, defaulting to the file at
point.
+@item @kbd{w m} (@code{magit-am-apply-maildir})
@kindex w m
-@cindex magit-am-apply-maildir
-@item @kbd{w m} @tie{}@tie{}@tie{}@tie{}(@code{magit-am-apply-maildir})
-
+@findex magit-am-apply-maildir
This command applies patches from a maildir.
+@item @kbd{w a} (@code{magit-patch-apply})
@kindex w a
-@cindex magit-patch-apply
-@item @kbd{w a} @tie{}@tie{}@tie{}@tie{}(@code{magit-patch-apply})
-
+@findex magit-patch-apply
This command applies a plain patch. For a longer description see
@ref{Plain Patches}. This command is only available from the @code{magit-am}
transient for historic reasons.
@@ -9063,23 +8298,20 @@ When an "am" operation is in progress, then the
transient instead
features the following suffix commands.
@table @asis
+@item @kbd{w w} (@code{magit-am-continue})
@kindex w w
-@cindex magit-am-continue
-@item @kbd{w w} @tie{}@tie{}@tie{}@tie{}(@code{magit-am-continue})
-
+@findex magit-am-continue
This command resumes the current patch applying sequence.
+@item @kbd{w s} (@code{magit-am-skip})
@kindex w s
-@cindex magit-am-skip
-@item @kbd{w s} @tie{}@tie{}@tie{}@tie{}(@code{magit-am-skip})
-
+@findex magit-am-skip
This command skips the stopped at patch during a patch applying
sequence.
+@item @kbd{w a} (@code{magit-am-abort})
@kindex w a
-@cindex magit-am-abort
-@item @kbd{w a} @tie{}@tie{}@tie{}@tie{}(@code{magit-am-abort})
-
+@findex magit-am-abort
This command aborts the current patch applying sequence. This
discards all changes made since the sequence started.
@end table
@@ -9117,25 +8349,22 @@ the git-tag(1) manpage.
@end iftex
@table @asis
+@item @kbd{t} (@code{magit-tag})
@kindex t
-@cindex magit-tag
-@item @kbd{t} @tie{}@tie{}@tie{}@tie{}(@code{magit-tag})
-
+@findex magit-tag
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
+@item @kbd{t t} (@code{magit-tag-create})
@kindex t t
-@cindex magit-tag-create
-@item @kbd{t t} @tie{}@tie{}@tie{}@tie{}(@code{magit-tag-create})
-
+@findex magit-tag-create
This command creates a new tag with the given NAME at REV@. With a
prefix argument it creates an annotated tag.
+@item @kbd{t r} (@code{magit-tag-release})
@kindex t r
-@cindex magit-tag-release
-@item @kbd{t r} @tie{}@tie{}@tie{}@tie{}(@code{magit-tag-release})
-
+@findex magit-tag-release
This commands creates a release tag. It assumes that release tags
match @code{magit-release-tag-regexp}.
@@ -9154,19 +8383,17 @@ it proposes something like "Foo-Bar 1.2.3", given, for
example, a
TAG "v1.2.3" and a repository located at something like
"/path/to/foo-bar".
+@item @kbd{t k} (@code{magit-tag-delete})
@kindex t k
-@cindex magit-tag-delete
-@item @kbd{t k} @tie{}@tie{}@tie{}@tie{}(@code{magit-tag-delete})
-
+@findex magit-tag-delete
This command deletes one or more tags. If the region marks multiple
tags (and nothing else), then it offers to delete those. Otherwise,
it prompts for a single tag to be deleted, defaulting to the tag at
point.
+@item @kbd{t p} (@code{magit-tag-prune})
@kindex t p
-@cindex magit-tag-prune
-@item @kbd{t p} @tie{}@tie{}@tie{}@tie{}(@code{magit-tag-prune})
-
+@findex magit-tag-prune
This command offers to delete tags missing locally from REMOTE, and
vice versa.
@end table
@@ -9188,38 +8415,34 @@ the git-notes(1) manpage.
@end iftex
@table @asis
+@item @kbd{T} (@code{magit-notes})
@kindex T
-@cindex magit-notes
-@item @kbd{T} @tie{}@tie{}@tie{}@tie{}(@code{magit-notes})
-
+@findex magit-notes
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
+@item @kbd{T T} (@code{magit-notes-edit})
@kindex T T
-@cindex magit-notes-edit
-@item @kbd{T T} @tie{}@tie{}@tie{}@tie{}(@code{magit-notes-edit})
-
+@findex magit-notes-edit
Edit the note attached to a commit, defaulting to the commit at
point.
By default use the value of Git variable @code{core.notesRef} or
"refs/notes/commits" if that is undefined.
+@item @kbd{T r} (@code{magit-notes-remove})
@kindex T r
-@cindex magit-notes-remove
-@item @kbd{T r} @tie{}@tie{}@tie{}@tie{}(@code{magit-notes-remove})
-
+@findex magit-notes-remove
Remove the note attached to a commit, defaulting to the commit at
point.
By default use the value of Git variable @code{core.notesRef} or
"refs/notes/commits" if that is undefined.
+@item @kbd{T p} (@code{magit-notes-prune})
@kindex T p
-@cindex magit-notes-prune
-@item @kbd{T p} @tie{}@tie{}@tie{}@tie{}(@code{magit-notes-prune})
-
+@findex magit-notes-prune
Remove notes about unreachable commits.
@end table
@@ -9228,10 +8451,9 @@ conflicts which have to resolved in the temporary
worktree
".git/NOTES@math{_MERGE}@math{_WORKTREE}".
@table @asis
+@item @kbd{T m} (@code{magit-notes-merge})
@kindex T m
-@cindex magit-notes-merge
-@item @kbd{T m} @tie{}@tie{}@tie{}@tie{}(@code{magit-notes-merge})
-
+@findex magit-notes-merge
Merge the notes of a ref read from the user into the current notes
ref. The current notes ref is the value of Git variable
@code{core.notesRef} or "refs/notes/commits" if that is undefined.
@@ -9241,17 +8463,15 @@ When a notes merge is in progress then the transient
features the
following suffix commands, instead of those listed above.
@table @asis
+@item @kbd{T c} (@code{magit-notes-merge-commit})
@kindex T c
-@cindex magit-notes-merge-commit
-@item @kbd{T c} @tie{}@tie{}@tie{}@tie{}(@code{magit-notes-merge-commit})
-
+@findex magit-notes-merge-commit
Commit the current notes ref merge, after manually resolving
conflicts.
+@item @kbd{T a} (@code{magit-notes-merge-abort})
@kindex T a
-@cindex magit-notes-merge-abort
-@item @kbd{T a} @tie{}@tie{}@tie{}@tie{}(@code{magit-notes-merge-abort})
-
+@findex magit-notes-merge-abort
Abort the current notes ref merge.
@end table
@@ -9260,13 +8480,11 @@ The following variables control what notes reference
@code{magit-notes-*},
values are displayed and can be modified.
@defvar core.notesRef
-
This variable specifies the notes ref that is displayed by default
and which commands act on by default.
@end defvar
@defvar notes.displayRef
-
This variable specifies additional notes ref to be displayed in
addition to the ref specified by @code{core.notesRef}. It can have
multiple values and may end with @code{*} to display all refs in the
@@ -9303,9 +8521,7 @@ display information about submodules directly in the
status buffer of
the super-repository by adding @code{magit-insert-modules} to the hook
@code{magit-status-sections-hook} as described in @ref{Status Module Sections}.
-@cindex magit-list-submodules
@deffn Command magit-list-submodules
-
This command displays a list of the current repository's submodules
in a separate buffer.
@@ -9313,7 +8529,6 @@ It can be invoked by pressing @code{RET} on the section
titled "Modules".
@end deffn
@defopt magit-submodule-list-columns
-
This option controls what columns are displayed by the command
@code{magit-list-submodules} and how they are displayed.
@@ -9331,10 +8546,9 @@ that supports the keys @code{:right-align} and
@code{:pad-right}.
@subsection Submodule Transient
@table @asis
+@item @kbd{o} (@code{magit-submodule})
@kindex o
-@cindex magit-submodule
-@item @kbd{o} @tie{}@tie{}@tie{}@tie{}(@code{magit-submodule})
-
+@findex magit-submodule
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
@@ -9349,61 +8563,53 @@ ignore the selection and the current module and instead
act on all
suitable modules.
@table @asis
+@item @kbd{o a} (@code{magit-submodule-add})
@kindex o a
-@cindex magit-submodule-add
-@item @kbd{o a} @tie{}@tie{}@tie{}@tie{}(@code{magit-submodule-add})
-
+@findex magit-submodule-add
This commands adds the repository at URL as a module. Optional PATH
is the path to the module relative to the root of the super-project.
If it is nil then the path is determined based on URL@.
+@item @kbd{o r} (@code{magit-submodule-register})
@kindex o r
-@cindex magit-submodule-register
-@item @kbd{o r} @tie{}@tie{}@tie{}@tie{}(@code{magit-submodule-register})
-
+@findex magit-submodule-register
This command registers the selected modules by copying their urls
from ".gitmodules" to "$GIT@math{_DIR}/config". These values can then be
edited before running @code{magit-submodule-populate}. If you don't need
to edit any urls, then use the latter directly.
+@item @kbd{o p} (@code{magit-submodule-populate})
@kindex o p
-@cindex magit-submodule-populate
-@item @kbd{o p} @tie{}@tie{}@tie{}@tie{}(@code{magit-submodule-populate})
-
+@findex magit-submodule-populate
This command creates the working directory or directories of the
selected modules, checking out the recorded commits.
+@item @kbd{o u} (@code{magit-submodule-update})
@kindex o u
-@cindex magit-submodule-update
-@item @kbd{o u} @tie{}@tie{}@tie{}@tie{}(@code{magit-submodule-update})
-
+@findex magit-submodule-update
This command updates the selected modules checking out the recorded
commits.
+@item @kbd{o s} (@code{magit-submodule-synchronize})
@kindex o s
-@cindex magit-submodule-synchronize
-@item @kbd{o s} @tie{}@tie{}@tie{}@tie{}(@code{magit-submodule-synchronize})
-
+@findex magit-submodule-synchronize
This command synchronizes the urls of the selected modules, copying
the values from ".gitmodules" to the ".git/config" of the
super-project as well those of the modules.
+@item @kbd{o d} (@code{magit-submodule-unpopulate})
@kindex o d
-@cindex magit-submodule-unpopulate
-@item @kbd{o d} @tie{}@tie{}@tie{}@tie{}(@code{magit-submodule-unpopulate})
-
+@findex magit-submodule-unpopulate
This command removes the working directory of the selected modules.
+@item @kbd{o l} (@code{magit-list-submodules})
@kindex o l
-@cindex magit-list-submodules
-@item @kbd{o l} @tie{}@tie{}@tie{}@tie{}(@code{magit-list-submodules})
-
+@findex magit-list-submodules
This command displays a list of the current repository's modules.
+@item @kbd{o f} (@code{magit-fetch-modules})
@kindex o f
-@cindex magit-fetch-modules
-@item @kbd{o f} @tie{}@tie{}@tie{}@tie{}(@code{magit-fetch-modules})
-
+@findex magit-fetch-modules
This command fetches all modules.
Option @code{magit-fetch-modules-jobs} controls how many submodules are
@@ -9429,17 +8635,15 @@ the git-subtree(1) manpage.
@end iftex
@table @asis
+@item @kbd{O} (@code{magit-subtree})
@kindex O
-@cindex magit-subtree
-@item @kbd{O} @tie{}@tie{}@tie{}@tie{}(@code{magit-subtree})
-
+@findex magit-subtree
This transient prefix command binds the two sub-transients; one for
importing a subtree and one for exporting a subtree.
+@item @kbd{O i} (@code{magit-subtree-import})
@kindex O i
-@cindex magit-subtree-import
-@item @kbd{O i} @tie{}@tie{}@tie{}@tie{}(@code{magit-subtree-import})
-
+@findex magit-subtree-import
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
@@ -9450,34 +8654,29 @@ If the @code{--prefix} argument is set, then the suffix
commands use that
prefix without prompting the user. If it is unset, then they read
the prefix in the minibuffer.
+@item @kbd{O i a} (@code{magit-subtree-add})
@kindex O i a
-@cindex magit-subtree-add
-@item @kbd{O i a} @tie{}@tie{}@tie{}@tie{}(@code{magit-subtree-add})
-
+@findex magit-subtree-add
This command adds COMMIT from REPOSITORY as a new subtree at PREFIX@.
+@item @kbd{O i c} (@code{magit-subtree-add-commit})
@kindex O i c
-@cindex magit-subtree-add-commit
-@item @kbd{O i c} @tie{}@tie{}@tie{}@tie{}(@code{magit-subtree-add-commit})
-
+@findex magit-subtree-add-commit
This command add COMMIT as a new subtree at PREFIX@.
+@item @kbd{O i m} (@code{magit-subtree-merge})
@kindex O i m
-@cindex magit-subtree-merge
-@item @kbd{O i m} @tie{}@tie{}@tie{}@tie{}(@code{magit-subtree-merge})
-
+@findex magit-subtree-merge
This command merges COMMIT into the PREFIX subtree.
+@item @kbd{O i f} (@code{magit-subtree-pull})
@kindex O i f
-@cindex magit-subtree-pull
-@item @kbd{O i f} @tie{}@tie{}@tie{}@tie{}(@code{magit-subtree-pull})
-
+@findex magit-subtree-pull
This command pulls COMMIT from REPOSITORY into the PREFIX subtree.
+@item @kbd{O e} (@code{magit-subtree-export})
@kindex O e
-@cindex magit-subtree-export
-@item @kbd{O e} @tie{}@tie{}@tie{}@tie{}(@code{magit-subtree-export})
-
+@findex magit-subtree-export
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
@@ -9488,17 +8687,15 @@ If the @code{--prefix} argument is set, then the suffix
commands use that
prefix without prompting the user. If it is unset, then they read
the prefix in the minibuffer.
+@item @kbd{O e p} (@code{magit-subtree-push})
@kindex O e p
-@cindex magit-subtree-push
-@item @kbd{O e p} @tie{}@tie{}@tie{}@tie{}(@code{magit-subtree-push})
-
+@findex magit-subtree-push
This command extract the history of the subtree PREFIX and pushes it
to REF on REPOSITORY@.
+@item @kbd{O e s} (@code{magit-subtree-split})
@kindex O e s
-@cindex magit-subtree-split
-@item @kbd{O e s} @tie{}@tie{}@tie{}@tie{}(@code{magit-subtree-split})
-
+@findex magit-subtree-split
This command extracts the history of the subtree PREFIX@.
@end table
@@ -9519,42 +8716,36 @@ the git-worktree(1) manpage.
@end iftex
@table @asis
+@item @kbd{Z} (@code{magit-worktree})
@kindex Z
-@cindex magit-worktree
-@item @kbd{Z} @tie{}@tie{}@tie{}@tie{}(@code{magit-worktree})
-
+@findex magit-worktree
This transient prefix command binds the following suffix commands
and displays them in a temporary buffer until a suffix is invoked.
+@item @kbd{Z b} (@code{magit-worktree-checkout})
@kindex Z b
-@cindex magit-worktree-checkout
-@item @kbd{Z b} @tie{}@tie{}@tie{}@tie{}(@code{magit-worktree-checkout})
-
+@findex magit-worktree-checkout
Checkout BRANCH in a new worktree at PATH@.
+@item @kbd{Z c} (@code{magit-worktree-branch})
@kindex Z c
-@cindex magit-worktree-branch
-@item @kbd{Z c} @tie{}@tie{}@tie{}@tie{}(@code{magit-worktree-branch})
-
+@findex magit-worktree-branch
Create a new BRANCH and check it out in a new worktree at PATH@.
+@item @kbd{Z m} (@code{magit-worktree-move})
@kindex Z m
-@cindex magit-worktree-move
-@item @kbd{Z m} @tie{}@tie{}@tie{}@tie{}(@code{magit-worktree-move})
-
+@findex magit-worktree-move
Move an existing worktree to a new PATH@.
+@item @kbd{Z k} (@code{magit-worktree-delete})
@kindex Z k
-@cindex magit-worktree-delete
-@item @kbd{Z k} @tie{}@tie{}@tie{}@tie{}(@code{magit-worktree-delete})
-
+@findex magit-worktree-delete
Delete a worktree, defaulting to the worktree at point.
The primary worktree cannot be deleted.
+@item @kbd{Z g} (@code{magit-worktree-status})
@kindex Z g
-@cindex magit-worktree-status
-@item @kbd{Z g} @tie{}@tie{}@tie{}@tie{}(@code{magit-worktree-status})
-
+@findex magit-worktree-status
Show the status for the worktree at point.
If there is no worktree at point, then read one in the minibuffer.
@@ -9578,9 +8769,7 @@ the <a
href="http://git-scm.com/docs/git-bundle";>git-bundle(1)</a> manpage.
the git-bundle(1) manpage.
@end iftex
-@cindex magit-bundle
@deffn Command magit-bundle
-
This transient prefix command binds several suffix commands for
running @code{git bundle} subcommands and displays them in a temporary
buffer until a suffix is invoked.
@@ -9589,18 +8778,13 @@ buffer until a suffix is invoked.
@node Common Commands
@section Common Commands
-@cindex magit-switch-to-repository-buffer
@deffn Command magit-switch-to-repository-buffer
@end deffn
-@cindex magit-switch-to-repository-buffer-other-window
@deffn Command magit-switch-to-repository-buffer-other-window
@end deffn
-@cindex magit-switch-to-repository-buffer-other-frame
@deffn Command magit-switch-to-repository-buffer-other-frame
@end deffn
-@cindex magit-display-repository-buffer
@deffn Command magit-display-repository-buffer
-
These commands read any existing Magit buffer that belongs to the
current repository from the user and then switch to the selected
buffer (without refreshing it).
@@ -9614,10 +8798,9 @@ major-modes derive from @code{magit-mode}. There are
other common commands
beside the ones below, but these didn't fit well anywhere else.
@table @asis
+@item @kbd{C-w} (@code{magit-copy-section-value})
@kindex C-w
-@cindex magit-copy-section-value
-@item @kbd{C-w} @tie{}@tie{}@tie{}@tie{}(@code{magit-copy-section-value})
-
+@findex magit-copy-section-value
This command saves the value of the current section to the
@code{kill-ring}, and, provided that the current section is a commit,
branch, or tag section, it also pushes the (referenced) revision to
@@ -9634,10 +8817,9 @@ within a hunk, then it strips the diff marker column and
keeps
only either the added or removed lines, depending on the sign of
the prefix argument.
+@item @kbd{M-w} (@code{magit-copy-buffer-revision})
@kindex M-w
-@cindex magit-copy-buffer-revision
-@item @kbd{M-w} @tie{}@tie{}@tie{}@tie{}(@code{magit-copy-buffer-revision})
-
+@findex magit-copy-buffer-revision
This command saves the revision being displayed in the current buffer
to the @code{kill-ring} and also pushes it to the @code{magit-revision-stack}.
It
is mainly intended for use in @code{magit-revision-mode} buffers, the only
@@ -9683,7 +8865,6 @@ Checking out another branch (or detaching @code{HEAD})
causes the use of
different wip refs for subsequent changes.
@defopt magit-wip-mode
-
When this mode is enabled, then uncommitted changes are committed
to dedicated work-in-progress refs whenever appropriate (i.e. when
dataloss would be a possibility otherwise).
@@ -9701,9 +8882,7 @@ To view the log for a branch and its wip refs use the
commands
@code{magit-wip-log} and @code{magit-wip-log-current}. You should use
@code{--graph} when
using these commands.
-@cindex magit-wip-log
@deffn Command magit-wip-log
-
This command shows the log for a branch and its wip refs.
With a negative prefix argument only the worktree wip ref is shown.
@@ -9712,9 +8891,7 @@ The absolute numeric value of the prefix argument
controls how many
value of @code{magit-wip-merge-branch} is @code{nil}.
@end deffn
-@cindex magit-wip-log-current
@deffn Command magit-wip-log-current
-
This command shows the log for the current branch and its wip refs.
With a negative prefix argument only the worktree wip ref is shown.
@@ -9724,10 +8901,9 @@ value of @code{magit-wip-merge-branch} is @code{nil}.
@end deffn
@table @asis
+@item @kbd{X w} (@code{magit-reset-worktree})
@kindex X w
-@cindex magit-reset-worktree
-@item @kbd{X w} @tie{}@tie{}@tie{}@tie{}(@code{magit-reset-worktree})
-
+@findex magit-reset-worktree
This command resets the working tree to some commit read from the
user and defaulting to the commit at point, while keeping the @code{HEAD}
and index as-is.
@@ -9750,20 +8926,16 @@ then you can explicitly request that all changes to all
tracked files
are being committed.
@table @asis
-@kindex M-x magit-wip-commit
-@cindex magit-wip-commit
-@item @kbd{M-x magit-wip-commit}
@tie{}@tie{}@tie{}@tie{}(@code{magit-wip-commit})
-
+@item @kbd{M-x magit-wip-commit}
+@findex magit-wip-commit
This command commits all changes to all tracked files to the index
and working tree work-in-progress refs. Like the modes described above,
it does not commit untracked files, but it does check all tracked
files for changes. Use this command when you suspect that the modes
might have overlooked a change made outside Emacs/Magit.
-
@end table
@defopt magit-wip-namespace
-
The namespace used for work-in-progress refs. It has to end with
a slash. The wip refs are named @code{<namespace>index/<branchref>} and
@code{<namespace>wtree/<branchref>}. When snapshots are created while
@@ -9771,7 +8943,6 @@ the @code{HEAD} is detached then @code{HEAD} is used in
place of @code{<branchre
@end defopt
@defopt magit-wip-mode-lighter
-
Mode-line lighter for @code{magit-wip--mode}.
@end defopt
@@ -9784,7 +8955,6 @@ Mode-line lighter for @code{magit-wip--mode}.
@subsection Wip Graph
@defopt magit-wip-merge-branch
-
This option controls whether the current branch is merged into the
wip refs after a new commit was created on the branch.
@@ -9856,14 +9026,12 @@ use the Custom interface to do so or call the
respective mode
functions.
@defopt magit-wip-after-save-mode
-
When this mode is enabled, then saving a buffer that visits a file
tracked in a Git repository causes its current state to be committed
to the working tree wip ref for the current branch.
@end defopt
@defopt magit-wip-after-apply-mode
-
When this mode is enabled, then applying (i.e. staging, unstaging,
discarding, reversing, and regularly applying) a change to a file
tracked in a Git repository causes its current state to be committed
@@ -9877,13 +9045,11 @@ that. Two additional modes exists that do commit to
the wip refs
before making changes that could cause the loss of earlier changes.
@defopt magit-wip-before-change-mode
-
When this mode is enabled, then certain commands commit the existing
changes to the files they are about to make changes to.
@end defopt
@defopt magit-wip-initial-backup-mode
-
When this mode is enabled, then the current version of a file is
committed to the worktree wip ref before the buffer visiting that
file is saved for the first time since the buffer was created.
@@ -9901,22 +9067,18 @@ backs up files that are tracked in a Git repository.
@end defopt
@defopt magit-wip-after-save-local-mode-lighter
-
Mode-line lighter for @code{magit-wip-after-save-local-mode}.
@end defopt
@defopt magit-wip-after-apply-mode-lighter
-
Mode-line lighter for @code{magit-wip-after-apply-mode}.
@end defopt
@defopt magit-wip-before-change-mode-lighter
-
Mode-line lighter for @code{magit-wip-before-change-mode}.
@end defopt
@defopt magit-wip-initial-backup-mode-lighter
-
Mode-line lighter for @code{magit-wip-initial-backup-mode}.
@end defopt
@@ -9941,40 +9103,35 @@ The key bindings shown below assume that you have not
improved the
binding for @code{magit-file-dispatch}.
@table @asis
+@item @kbd{C-c M-g} (@code{magit-file-dispatch})
@kindex C-c M-g
-@cindex magit-file-dispatch
-@item @kbd{C-c M-g} @tie{}@tie{}@tie{}@tie{}(@code{magit-file-dispatch})
-
+@findex magit-file-dispatch
This transient prefix command binds the following suffix commands
and displays them in a temporary buffer until a suffix is invoked.
When invoked in a buffer that does not visit a file, then it falls
back to regular @code{magit-dispatch}.
+@item @kbd{C-c M-g s} (@code{magit-stage-file})
@kindex C-c M-g s
-@cindex magit-stage-file
-@item @kbd{C-c M-g s} @tie{}@tie{}@tie{}@tie{}(@code{magit-stage-file})
-
+@findex magit-stage-file
Stage all changes to the file being visited in the current buffer.
+@item @kbd{C-c M-g u} (@code{magit-unstage-file})
@kindex C-c M-g u
-@cindex magit-unstage-file
-@item @kbd{C-c M-g u} @tie{}@tie{}@tie{}@tie{}(@code{magit-unstage-file})
-
+@findex magit-unstage-file
Unstage all changes to the file being visited in the current buffer.
+@item @kbd{C-c M-g c} (@code{magit-commit})
@kindex C-c M-g c
-@cindex magit-commit
-@item @kbd{C-c M-g c} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit})
-
+@findex magit-commit
This transient prefix command binds the following suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked. See @ref{Initiating a Commit}.
+@item @kbd{C-c M-g D} (@code{magit-diff})
@kindex C-c M-g D
-@cindex magit-diff
-@item @kbd{C-c M-g D} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff})
-
+@findex magit-diff
This transient prefix command binds several diff suffix commands and
infix arguments and displays them in a temporary buffer until a
suffix is invoked. See @ref{Diffing}.
@@ -9984,26 +9141,22 @@ If this command is invoked from a file-visiting buffer,
then the
initial value of the option (@code{--}) that limits the diff to certain
file(s) is set to the visited file.
+@item @kbd{C-c M-g d} (@code{magit-diff-buffer-file})
@kindex C-c M-g d
-@cindex magit-diff-buffer-file
-@item @kbd{C-c M-g d} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-buffer-file})
-
+@findex magit-diff-buffer-file
This command shows the diff for the file of blob that the current
buffer visits.
-
@end table
@defopt magit-diff-buffer-file-locked
-
This option controls whether @code{magit-diff-buffer-file} uses a dedicated
buffer. See @ref{Modes and Buffers}.
@end defopt
@table @asis
+@item @kbd{C-c M-g L} (@code{magit-log})
@kindex C-c M-g L
-@cindex magit-log
-@item @kbd{C-c M-g L} @tie{}@tie{}@tie{}@tie{}(@code{magit-log})
-
+@findex magit-log
This transient prefix command binds several log suffix commands and
infix arguments and displays them in a temporary buffer until a
suffix is invoked. See @ref{Logging}.
@@ -10013,34 +9166,29 @@ If this command is invoked from a file-visiting
buffer, then the
initial value of the option (@code{--}) that limits the log to certain
file(s) is set to the visited file.
+@item @kbd{C-c M-g l} (@code{magit-log-buffer-file})
@kindex C-c M-g l
-@cindex magit-log-buffer-file
-@item @kbd{C-c M-g l} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-buffer-file})
-
+@findex magit-log-buffer-file
This command shows the log for the file of blob that the current
buffer visits. Renames are followed when a prefix argument is used
or when @code{--follow} is an active log argument. When the region is
active, the log is restricted to the selected line range.
+@item @kbd{C-c M-g t} (@code{magit-log-trace-definition})
@kindex C-c M-g t
-@cindex magit-log-trace-definition
-@item @kbd{C-c M-g t}
@tie{}@tie{}@tie{}@tie{}(@code{magit-log-trace-definition})
-
+@findex magit-log-trace-definition
This command shows the log for the definition at point.
-
@end table
@defopt magit-log-buffer-file-locked
-
This option controls whether @code{magit-log-buffer-file} uses a dedicated
buffer. See @ref{Modes and Buffers}.
@end defopt
@table @asis
+@item @kbd{C-c M-g B} (@code{magit-blame})
@kindex C-c M-g B
-@cindex magit-blame
-@item @kbd{C-c M-g B} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame})
-
+@findex magit-blame
This transient prefix command binds all blaming suffix commands
along with the appropriate infix arguments and displays them in a
temporary buffer until a suffix is invoked.
@@ -10054,10 +9202,9 @@ also binds several blaming suffix commands directly.
See @ref{Blaming} for
information about those commands and bindings.
@table @asis
+@item @kbd{C-c M-g e} (@code{magit-edit-line-commit})
@kindex C-c M-g e
-@cindex magit-edit-line-commit
-@item @kbd{C-c M-g e} @tie{}@tie{}@tie{}@tie{}(@code{magit-edit-line-commit})
-
+@findex magit-edit-line-commit
This command makes the commit editable that added the current line.
With a prefix argument it makes the commit editable that removes the
@@ -10066,37 +9213,28 @@ editable using @code{git rebase --interactive} if it
is reachable from
@code{HEAD}, or by checking out the commit (or a branch that points at it)
otherwise.
+@item @kbd{C-c M-g p} (@code{magit-blob-previous})
@kindex C-c M-g p
-@cindex magit-blob-previous
-@item @kbd{C-c M-g p} @tie{}@tie{}@tie{}@tie{}(@code{magit-blob-previous})
-
+@findex magit-blob-previous
Visit the previous blob which modified the current file.
@end table
There are a few additional commands that operate on a single file but
are not enabled in the file transient command by default:
-@cindex magit-file-rename
@deffn Command magit-file-rename
-
This command renames a file read from the user.
@end deffn
-@cindex magit-file-delete
@deffn Command magit-file-delete
-
This command deletes a file read from the user.
@end deffn
-@cindex magit-file-untrack
@deffn Command magit-file-untrack
-
This command untracks a file read from the user.
@end deffn
-@cindex magit-file-checkout
@deffn Command magit-file-checkout
-
This command updates a file in the working tree and index to the
contents from a revision. Both the revision and file are read
from the user.
@@ -10116,22 +9254,19 @@ this minor mode. Currently this mode only establishes
a few key
bindings, but this might be extended.
@table @asis
+@item @kbd{p} (@code{magit-blob-previous})
@kindex p
-@cindex magit-blob-previous
-@item @kbd{p} @tie{}@tie{}@tie{}@tie{}(@code{magit-blob-previous})
-
+@findex magit-blob-previous
Visit the previous blob which modified the current file.
+@item @kbd{n} (@code{magit-blob-next})
@kindex n
-@cindex magit-blob-next
-@item @kbd{n} @tie{}@tie{}@tie{}@tie{}(@code{magit-blob-next})
-
+@findex magit-blob-next
Visit the next blob which modified the current file.
+@item @kbd{q} (@code{magit-kill-this-buffer})
@kindex q
-@cindex magit-kill-this-buffer
-@item @kbd{q} @tie{}@tie{}@tie{}@tie{}(@code{magit-kill-this-buffer})
-
+@findex magit-kill-this-buffer
Kill the current buffer.
@end table
@@ -10156,7 +9291,6 @@ overriding the value for Magit only by appending
something like
@code{("-c" "some.variable=compatible-value")} to
@code{magit-git-global-arguments}.
-
@item
Certain settings like @code{fetch.prune=true} are respected by Magit
commands (because they simply call the respective Git command) but
@@ -10223,11 +9357,9 @@ repository:
((magit-status-mode
. ((eval . (magit-disable-section-inserter 'magit-insert-tags-header)))))
@end lisp
-
@end itemize
@defun magit-disable-section-inserter fn
-
This function disables the section inserter FN in the current
repository. It is only intended for use in @code{.dir-locals.el} and
@code{.dir-locals-2.el}.
@@ -10249,7 +9381,6 @@ For example:
path = /path/to/huge-gitconfig
@end example
-
@item
@code{/path/to/huge-gitconfig}
@@ -10258,7 +9389,6 @@ For example:
showUntrackedFiles = no
@end example
-
@item
@code{$HOME/.emacs.d/init.el}
@@ -10521,7 +9651,6 @@ for more information.
@subsection Default Bindings
@defopt magit-define-global-key-bindings
-
This option controls whether some Magit commands are automatically
bound in the global keymap even before Magit is used for the first
time in the current session.
@@ -10635,54 +9764,45 @@ status, or output. Of course you could also use them
to run Git
commands that have side-effects, but that should be avoided.
@defun magit-git-exit-code &rest args
-
Executes git with ARGS and returns its exit code.
@end defun
@defun magit-git-success &rest args
-
Executes git with ARGS and returns @code{t} if the exit code is @code{0},
@code{nil}
otherwise.
@end defun
@defun magit-git-failure &rest args
-
Executes git with ARGS and returns @code{t} if the exit code is @code{1},
@code{nil}
otherwise.
@end defun
@defun magit-git-true &rest args
-
Executes git with ARGS and returns @code{t} if the first line printed by
git is the string "true", @code{nil} otherwise.
@end defun
@defun magit-git-false &rest args
-
Executes git with ARGS and returns @code{t} if the first line printed by
git is the string "false", @code{nil} otherwise.
@end defun
@defun magit-git-insert &rest args
-
Executes git with ARGS and inserts its output at point.
@end defun
@defun magit-git-string &rest args
-
Executes git with ARGS and returns the first line of its output. If
there is no output or if it begins with a newline character, then
this returns @code{nil}.
@end defun
@defun magit-git-lines &rest args
-
Executes git with ARGS and returns its output as a list of lines.
Empty lines anywhere in the output are omitted.
@end defun
@defun magit-git-items &rest args
-
Executes git with ARGS and returns its null-separated output as a
list. Empty items anywhere in the output are omitted.
@@ -10693,7 +9813,6 @@ repository's process buffer.
@end defun
@defun magit-process-git destination &rest args
-
Calls Git synchronously in a separate process, returning its exit
code. DESTINATION specifies how to handle the output, like for
@code{call-process}, except that file handlers are supported. Enables
@@ -10702,7 +9821,6 @@ conversion.
@end defun
@defun magit-process-file process &optional infile buffer display &rest args
-
Processes files synchronously in a separate process. Identical to
@code{process-file} but temporarily enables Cygwin's "noglob" option during
the call and ensures unix eol conversion.
@@ -10714,7 +9832,6 @@ actually supported. Such errors are usually not
reported, but when
they occur we need to be able to debug them.
@defopt magit-git-debug
-
Whether to report errors that occur when using @code{magit-git-insert},
@code{magit-git-string}, @code{magit-git-lines}, or @code{magit-git-items}.
This does
not actually raise an error. Instead a message is shown in the echo
@@ -10723,7 +9840,6 @@ current repository's process buffer.
@end defopt
@defun magit-git-str &rest args
-
This is a variant of @code{magit-git-string} that ignores the option
@code{magit-git-debug}. It is mainly intended to be used while handling
errors in functions that do respect that option. Using such a
@@ -10758,22 +9874,18 @@ For example after staging a change it is useful to
wait until after
the refresh because that also automatically moves to the next change.
@defun magit-call-git &rest args
-
Calls git synchronously with ARGS@.
@end defun
@defun magit-call-process program &rest args
-
Calls PROGRAM synchronously with ARGS@.
@end defun
@defun magit-run-git &rest args
-
Calls git synchronously with ARGS and then refreshes.
@end defun
@defun magit-run-git-with-input &rest args
-
Calls git synchronously with ARGS and sends it the content of the
current buffer on standard input.
@@ -10784,13 +9896,11 @@ synchronous.
@end defun
@defun magit-git &rest args
-
Calls git synchronously with ARGS for side-effects only. This
function does not refresh the buffer.
@end defun
@defun magit-git-wash washer &rest args
-
Execute Git with ARGS, inserting washed output at point. Actually
first insert the raw output at point. If there is no output call
@code{magit-cancel-section}. Otherwise temporarily narrow the buffer to
@@ -10801,7 +9911,6 @@ WASHER with ARGS as its sole argument.
And now for the asynchronous variants.
@defun magit-run-git-async &rest args
-
Start Git, prepare for refresh, and return the process object.
ARGS is flattened and then used as arguments to Git.
@@ -10815,7 +9924,6 @@ repository are reverted if @code{magit-revert-buffers}
is non-nil.
@end defun
@defun magit-run-git-with-editor &rest args
-
Export GIT@math{_EDITOR} and start Git. Also prepare for refresh and
return the process object. ARGS is flattened and then used as
arguments to Git.
@@ -10828,7 +9936,6 @@ still alive), as well as the respective Magit status
buffer.
@end defun
@defun magit-start-git input &rest args
-
Start Git, prepare for refresh, and return the process object.
If INPUT is non-nil, it has to be a buffer or the name of an
@@ -10848,7 +9955,6 @@ repository are reverted if @code{magit-revert-buffers}
is non-nil.
@end defun
@defun magit-start-process &rest args
-
Start PROGRAM, prepare for refresh, and return the process object.
If optional argument INPUT is non-nil, it has to be a buffer or
@@ -10871,13 +9977,11 @@ non-nil.
@end defun
@defvar magit-this-process
-
The child process which is about to start. This can be used to
change the filter and sentinel.
@end defvar
@defvar magit-process-raise-error
-
When this is non-nil, then @code{magit-process-sentinel} raises an error if
git exits with a non-zero exit status. For debugging purposes.
@end defvar
@@ -10895,7 +9999,6 @@ git exits with a non-zero exit status. For debugging
purposes.
@subsection Creating Sections
@defmac magit-insert-section &rest args
-
Insert a section at point.
TYPE is the section type, a symbol. Many commands that act on the
@@ -10932,7 +10035,6 @@ anything this time around.
@end defmac
@defun magit-insert-heading &rest args
-
Insert the heading for the section currently being inserted.
This function should only be used inside @code{magit-insert-section}.
@@ -10960,14 +10062,12 @@ that this function does insert a newline character if
necessary.
@end defun
@defun magit-cancel-section
-
Cancel the section currently being inserted. This exits the
innermost call to @code{magit-insert-section} and removes all traces of
what has already happened inside that call.
@end defun
@defun magit-define-section-jumper sym title &optional value
-
Define an interactive function to go to section SYM@. TITLE is the
displayed title of the section.
@end defun
@@ -10976,12 +10076,10 @@ displayed title of the section.
@subsection Section Selection
@defun magit-current-section
-
Return the section at point.
@end defun
@defun magit-region-sections &optional condition multiple
-
Return a list of the selected sections.
When the region is active and constitutes a valid section
@@ -11009,7 +10107,6 @@ forms CONDITION can take.
@end defun
@defun magit-region-values &optional condition multiple
-
Return a list of the values of the selected sections.
Return the values that themselves would be returned by
@@ -11020,29 +10117,23 @@ Return the values that themselves would be returned by
@subsection Matching Sections
@table @asis
-@kindex M-x magit-describe-section-briefly
-@cindex magit-describe-section-briefly
-@item @kbd{M-x magit-describe-section-briefly}
@tie{}@tie{}@tie{}@tie{}(@code{magit-describe-section-briefly})
-
+@item @kbd{M-x magit-describe-section-briefly}
+@findex magit-describe-section-briefly
Show information about the section at point. This command is
intended for debugging purposes.
-
@end table
@defun magit-section-ident section
-
Return an unique identifier for SECTION@. The return value has the
form @code{((TYPE . VALUE)...)}.
@end defun
@defun magit-get-section ident &optional root
-
Return the section identified by IDENT@. IDENT has to be a list as
returned by @code{magit-section-ident}.
@end defun
@defun magit-section-match condition &optional section
-
Return @code{t} if SECTION matches CONDITION@.
SECTION defaults to the section at point. If SECTION is not
specified and there also is no section at point, then return
@@ -11055,7 +10146,6 @@ CONDITION can take the following forms:
matches if any of the CONDITIONs matches.
-
@item
@code{[CLASS...]}
@@ -11064,14 +10154,12 @@ as the first CLASS or a subclass of that;
the section's parent class matches the
second CLASS; and so on.
-
@item
@code{[* CLASS...]}
matches sections that match @code{[CLASS...]} and
also recursively all their child sections.
-
@item
@code{CLASS}
@@ -11094,7 +10182,6 @@ of course you want to be that precise.
@end defun
@defun magit-section-value-if condition &optional section
-
If the section at point matches CONDITION, then return its value.
If optional SECTION is non-nil then test whether that matches
@@ -11106,7 +10193,6 @@ See @code{magit-section-match} for the forms CONDITION
can take.
@end defun
@defun magit-section-case &rest clauses
-
Choose among clauses on the type of the section at point.
Each clause looks like (CONDITION BODY@dots{}). The type of the
@@ -11123,7 +10209,6 @@ point.
@end defun
@defvar magit-root-section
-
The root section in the current buffer. All other sections are
descendants of this section. The value of this variable is set by
@code{magit-insert-section} and you should never modify it.
@@ -11132,7 +10217,6 @@ descendants of this section. The value of this
variable is set by
For diff related sections a few additional tools exist.
@defun magit-diff-type &optional section
-
Return the diff type of SECTION@.
The returned type is one of the symbols @code{staged}, @code{unstaged},
@code{committed},
@@ -11155,7 +10239,6 @@ other means. In @code{magit-revision-mode} buffers the
type is always
@end defun
@defun magit-diff-scope &optional section strict
-
Return the diff scope of SECTION or the selected section(s).
A diff's "scope" describes what part of a diff is selected, it is a
@@ -11190,7 +10273,6 @@ where @code{*} may be something like @code{diff}) with
the value of
@code{magit-refresh-args} as arguments.
@defmac magit-mode-setup buffer switch-func mode refresh-func &optional
refresh-args
-
This function displays and selects BUFFER, turns on MODE, and
refreshes a first time.
@@ -11205,7 +10287,6 @@ All arguments are evaluated before switching to BUFFER@.
@end defmac
@defun magit-mode-display-buffer buffer mode &optional switch-function
-
This function display BUFFER in some window and select it. BUFFER
may be a buffer or a string, the name of a buffer. The buffer is
returned.
@@ -11220,14 +10301,12 @@ derives from @code{magit-mode}. Otherwise
@code{switch-to-buffer} is used.
@end defun
@defvar magit-refresh-function
-
The value of this buffer-local variable is the function used to
refresh the current buffer. It is called with @code{magit-refresh-args} as
arguments.
@end defvar
@defvar magit-refresh-args
-
The list of arguments used by @code{magit-refresh-function} to refresh the
current buffer. @code{magit-refresh-function} is called with these
arguments.
@@ -11791,18 +10870,14 @@ issue. Please include all relevant output when
reporting an
issue.
@table @asis
-@kindex M-x magit-version
-@cindex magit-version
-@item @kbd{M-x magit-version} @tie{}@tie{}@tie{}@tie{}(@code{magit-version})
-
+@item @kbd{M-x magit-version}
+@findex magit-version
This command shows the currently used versions of Magit, Git, and
Emacs in the echo area. Non-interactively this just returns the
Magit version.
-@kindex M-x magit-emacs-Q-command
-@cindex magit-emacs-Q-command
-@item @kbd{M-x magit-emacs-Q-command}
@tie{}@tie{}@tie{}@tie{}(@code{magit-emacs-Q-command})
-
+@item @kbd{M-x magit-emacs-Q-command}
+@findex magit-emacs-Q-command
This command shows a debugging shell command in the echo area and
adds it to the kill ring. Paste that command into a shell and run
it.
@@ -11815,28 +10890,22 @@ issue lays with Magit or something else.
If you run Magit from its Git repository, then you should be able to
use @code{make emacs-Q} instead of the output of this command.
-@kindex M-x magit-toggle-verbose-refresh
-@cindex magit-toggle-verbose-refresh
-@item @kbd{M-x magit-toggle-verbose-refresh}
@tie{}@tie{}@tie{}@tie{}(@code{magit-toggle-verbose-refresh})
-
+@item @kbd{M-x magit-toggle-verbose-refresh}
+@findex magit-toggle-verbose-refresh
This command toggles whether Magit refreshes buffers verbosely.
Enabling this helps figuring out which sections are bottlenecks.
The additional output can be found in the @code{*Messages*} buffer.
-@kindex M-x magit-debug-git-executable
-@cindex magit-debug-git-executable
-@item @kbd{M-x magit-debug-git-executable}
@tie{}@tie{}@tie{}@tie{}(@code{magit-debug-git-executable})
-
+@item @kbd{M-x magit-debug-git-executable}
+@findex magit-debug-git-executable
This command displays a buffer containing information about the
available and used @code{git} executable(s), and can be useful when
investigating @code{exec-path} issues.
Also see @ref{Git Executable}.
-@kindex M-x with-editor-debug
-@cindex with-editor-debug
-@item @kbd{M-x with-editor-debug}
@tie{}@tie{}@tie{}@tie{}(@code{with-editor-debug})
-
+@item @kbd{M-x with-editor-debug}
+@findex with-editor-debug
This command displays a buffer containing information about the
available and used @code{emacsclient} executable(s), and can be useful
when investigating why Magit (or rather @code{with-editor}) cannot find
@@ -11852,13 +10921,8 @@ Please also see the @ref{FAQ}.
@printindex ky
-@node Command Index
-@appendix Command Index
-
-@printindex cp
-
-@node Function Index
-@appendix Function Index
+@node Function and Command Index
+@appendix Function and Command Index
@printindex fn