Klimi's new dotfiles with stow.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

3387 lines
182 KiB

4 years ago
  1. This is magit.info, produced by makeinfo version 6.5 from magit.texi.
  2. Copyright (C) 2015-2019 Jonas Bernoulli <jonas@bernoul.li>
  3. You can redistribute this document and/or modify it under the terms
  4. of the GNU General Public License as published by the Free Software
  5. Foundation, either version 3 of the License, or (at your option)
  6. any later version.
  7. This document is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  10. General Public License for more details.
  11. INFO-DIR-SECTION Emacs
  12. START-INFO-DIR-ENTRY
  13. * Magit: (magit). Using Git from Emacs with Magit.
  14. END-INFO-DIR-ENTRY
  15. 
  16. File: magit.info, Node: Wip Graph, Next: Legacy Wip Modes, Up: Wip Modes
  17. 8.7.1 Wip Graph
  18. ---------------
  19. -- User Option: magit-wip-merge-branch
  20. This option controls whether the current branch is merged into the
  21. wip refs after a new commit was created on the branch.
  22. If non-nil and the current branch has new commits, then it is
  23. merged into the wip ref before creating a new wip commit. This
  24. makes it easier to inspect wip history and the wip commits are
  25. never garbage collected.
  26. If nil and the current branch has new commits, then the wip ref is
  27. reset to the tip of the branch before creating a new wip commit.
  28. With this setting wip commits are eventually garbage collected.
  29. When ‘magit-wip-merge-branch’ is ‘t’, then the history looks like
  30. this:
  31. *--*--*--*--*--* refs/wip/index/refs/heads/master
  32. / / /
  33. A-----B-----C refs/heads/master
  34. When ‘magit-wip-merge-branch’ is ‘nil’, then creating a commit on the
  35. real branch and then making a change causes the wip refs to be recreated
  36. to fork from the new commit. But the old commits on the wip refs are
  37. not lost. They are still available from the reflog. To make it easier
  38. to see when the fork point of a wip ref was changed, an additional
  39. commit with the message "restart autosaving" is created on it (‘xxO’
  40. commits below are such boundary commits).
  41. Starting with
  42. BI0---BI1 refs/wip/index/refs/heads/master
  43. /
  44. A---B refs/heads/master
  45. \
  46. BW0---BW1 refs/wip/wtree/refs/heads/master
  47. and committing the staged changes and editing and saving a file would
  48. result in
  49. BI0---BI1 refs/wip/index/refs/heads/master
  50. /
  51. A---B---C refs/heads/master
  52. \ \
  53. \ CW0---CW1 refs/wip/wtree/refs/heads/master
  54. \
  55. BW0---BW1 refs/wip/wtree/refs/heads/master@{2}
  56. The fork-point of the index wip ref is not changed until some change
  57. is being staged. Likewise just checking out a branch or creating a
  58. commit does not change the fork-point of the working tree wip ref. The
  59. fork-points are not adjusted until there actually is a change that
  60. should be committed to the respective wip ref.
  61. 
  62. File: magit.info, Node: Legacy Wip Modes, Prev: Wip Graph, Up: Wip Modes
  63. 8.7.2 Legacy Wip Modes
  64. ----------------------
  65. It is recommended that you use the mode ‘magit-wip-mode’ (which see) and
  66. ignore the existence of the following modes, which are preserved for
  67. historic reasons.
  68. Setting the following variables directly does not take effect; either
  69. use the Custom interface to do so or call the respective mode functions.
  70. -- User Option: magit-wip-after-save-mode
  71. When this mode is enabled, then saving a buffer that visits a file
  72. tracked in a Git repository causes its current state to be
  73. committed to the working tree wip ref for the current branch.
  74. -- User Option: magit-wip-after-apply-mode
  75. When this mode is enabled, then applying (i.e. staging, unstaging,
  76. discarding, reversing, and regularly applying) a change to a file
  77. tracked in a Git repository causes its current state to be
  78. committed to the index and/or working tree wip refs for the current
  79. branch.
  80. If you only ever edit files using Emacs and only ever interact with
  81. Git using Magit, then the above two modes should be enough to protect
  82. each and every change from accidental loss. In practice nobody does
  83. that. Two additional modes exists that do commit to the wip refs before
  84. making changes that could cause the loss of earlier changes.
  85. -- User Option: magit-wip-before-change-mode
  86. When this mode is enabled, then certain commands commit the
  87. existing changes to the files they are about to make changes to.
  88. -- User Option: magit-wip-initial-backup-mode
  89. When this mode is enabled, then the current version of a file is
  90. committed to the worktree wip ref before the buffer visiting that
  91. file is saved for the first time since the buffer was created.
  92. This backs up the same version of the file that ‘backup-buffer’
  93. would save. While ‘backup-buffer’ uses a backup file, this mode
  94. uses the same worktree wip ref as used by the other Magit Wip
  95. modes. Like ‘backup-buffer’, it only does this once; unless you
  96. kill the buffer and visit the file again only one backup will be
  97. created per Emacs session.
  98. This mode ignores the variables that affect ‘backup-buffer’ and can
  99. be used along-side that function, which is recommended because it
  100. only backs up files that are tracked in a Git repository.
  101. -- User Option: magit-wip-after-save-local-mode-lighter
  102. Mode-line lighter for ‘magit-wip-after-save-local-mode’.
  103. -- User Option: magit-wip-after-apply-mode-lighter
  104. Mode-line lighter for ‘magit-wip-after-apply-mode’.
  105. -- User Option: magit-wip-before-change-mode-lighter
  106. Mode-line lighter for ‘magit-wip-before-change-mode’.
  107. -- User Option: magit-wip-initial-backup-mode-lighter
  108. Mode-line lighter for ‘magit-wip-initial-backup-mode’.
  109. 
  110. File: magit.info, Node: Minor Mode for Buffers Visiting Files, Next: Minor Mode for Buffers Visiting Blobs, Prev: Wip Modes, Up: Miscellaneous
  111. 8.8 Minor Mode for Buffers Visiting Files
  112. =========================================
  113. The minor-mode ‘magit-file-mode’ enables certain Magit features in
  114. file-visiting buffers belonging to a Git repository. The globalized
  115. variant ‘global-magit-file-mode’ enables the local mode in all such
  116. buffers. It is enabled by default. Currently the local mode only
  117. establishes a few key bindings, but this might be extended in the
  118. future.
  119. -- User Option: global-magit-file-mode
  120. Whether to establish certain Magit key bindings in all
  121. file-visiting buffers belonging to any Git repository. This is
  122. enabled by default. This globalized mode turns on the local
  123. minor-mode ‘magit-file-mode’ in all suitable buffers.
  124. -- Variable: magit-file-mode-map
  125. This keymap is used by the local minor-mode ‘magit-file-mode’ and
  126. establishes the key bindings described below.
  127. Note that the default binding for ‘magit-file-dispatch’ is very
  128. cumbersome to use and that we recommend that you add a better
  129. binding.
  130. Instead of ‘C-c M-g’ I would have preferred to use ‘C-c g’ because
  131. (1) it is similar to ‘C-x g’ (the recommended global binding for
  132. ‘~magit-status’), (2) we cannot use ‘C-c C-g’ because we have been
  133. recommending that that be bound to ‘magit-dispatch’ for a long
  134. time, (3) we cannot use ‘C-x C-g’ because that is a convenient way
  135. of aborting the incomplete key sequence ‘C-x’, and most importantly
  136. (4) it would make it much easier to type the next key (a suffix
  137. binding) because most of those are letters.
  138. For example ‘C-c g b’ is much easier to type than ‘C-c M-g b’. For
  139. suffix bindings that use uppercase letters, the default is just
  140. horrible—having to use e.g. ‘C-c M-g B’ (‘Control+c Meta+g
  141. Shift+b’) would drive anyone up the walls (or to Vim).
  142. However ‘C-c LETTER’ bindings are reserved for users (see *note
  143. (elisp)Key Binding Conventions::). Packages are forbidden from
  144. using those. Doing so anyway is considered heresy. Therefore if
  145. you want a better binding, you have to add it yourself:
  146. (define-key magit-file-mode-map
  147. (kbd "C-c g") 'magit-file-dispatch)
  148. The key bindings shown below assume that you have not improved the
  149. binding for ‘magit-file-dispatch’.
  150. ‘C-c M-g’ (‘magit-file-dispatch’)
  151. This transient prefix command binds the following suffix commands
  152. and displays them in a temporary buffer until a suffix is invoked.
  153. ‘C-c M-g s’ (‘magit-stage-file’)
  154. Stage all changes to the file being visited in the current buffer.
  155. ‘C-c M-g u’ (‘magit-unstage-file’)
  156. Unstage all changes to the file being visited in the current
  157. buffer.
  158. ‘C-c M-g c’ (‘magit-commit’)
  159. This transient prefix command binds the following suffix commands
  160. along with the appropriate infix arguments and displays them in a
  161. temporary buffer until a suffix is invoked. See *note Initiating a
  162. Commit::.
  163. ‘C-c M-g D’ (‘magit-diff’)
  164. This transient prefix command binds several diff suffix commands
  165. and infix arguments and displays them in a temporary buffer until a
  166. suffix is invoked. See *note Diffing::.
  167. This is the same command that ‘d’ is bound to in Magit buffers. If
  168. this command is invoked from a file-visiting buffer, then the
  169. initial value of the option (‘--’) that limits the diff to certain
  170. file(s) is set to the visited file.
  171. ‘C-c M-g d’ (‘magit-diff-buffer-file’)
  172. This command shows the diff for the file of blob that the current
  173. buffer visits.
  174. -- User Option: magit-diff-buffer-file-locked
  175. This option controls whether ‘magit-diff-buffer-file’ uses a
  176. dedicated buffer. See *note Modes and Buffers::.
  177. ‘C-c M-g L’ (‘magit-log’)
  178. This transient prefix command binds several log suffix commands and
  179. infix arguments and displays them in a temporary buffer until a
  180. suffix is invoked. See *note Logging::.
  181. This is the same command that ‘l’ is bound to in Magit buffers. If
  182. this command is invoked from a file-visiting buffer, then the
  183. initial value of the option (‘--’) that limits the log to certain
  184. file(s) is set to the visited file.
  185. ‘C-c M-g l’ (‘magit-log-buffer-file’)
  186. This command shows the log for the file of blob that the current
  187. buffer visits. Renames are followed when a prefix argument is used
  188. or when ‘--follow’ is an active log argument. When the region is
  189. active, the log is restricted to the selected line range.
  190. ‘C-c M-g t’ (‘magit-log-trace-definition’)
  191. This command shows the log for the definition at point.
  192. -- User Option: magit-log-buffer-file-locked
  193. This option controls whether ‘magit-log-buffer-file’ uses a
  194. dedicated buffer. See *note Modes and Buffers::.
  195. ‘C-c M-g B’ (‘magit-blame’)
  196. This transient prefix command binds all blaming suffix commands
  197. along with the appropriate infix arguments and displays them in a
  198. temporary buffer until a suffix is invoked.
  199. For more information about this and the following commands also see
  200. *note Blaming::.
  201. In addition to the ‘magit-blame’ sub-transient, the dispatch
  202. transient also binds several blaming suffix commands directly. See
  203. *note Blaming:: for information about those commands and bindings.
  204. ‘C-c M-g e’ (‘magit-edit-line-commit’)
  205. This command makes the commit editable that added the current line.
  206. With a prefix argument it makes the commit editable that removes
  207. the line, if any. The commit is determined using ‘git blame’ and
  208. made editable using ‘git rebase --interactive’ if it is reachable
  209. from ‘HEAD’, or by checking out the commit (or a branch that points
  210. at it) otherwise.
  211. ‘C-c M-g p’ (‘magit-blob-previous’)
  212. Visit the previous blob which modified the current file.
  213. There are a few additional commands that operate on a single file but
  214. are not enabled in the file transient command by default:
  215. -- Command: magit-file-rename
  216. This command renames a file read from the user.
  217. -- Command: magit-file-delete
  218. This command deletes a file read from the user.
  219. -- Command: magit-file-untrack
  220. This command untracks a file read from the user.
  221. -- Command: magit-file-checkout
  222. This command updates a file in the working tree and index to the
  223. contents from a revision. Both the revision and file are read from
  224. the user.
  225. To enable them invoke the transient (‘C-c M-g’), enter "edit mode"
  226. (‘C-x l’), set the "transient level" (‘C-x l’ again), enter ‘5’, and
  227. leave edit mode (‘C-g’). Also see *note (transient)Enabling and
  228. Disabling Suffixes::.
  229. 
  230. File: magit.info, Node: Minor Mode for Buffers Visiting Blobs, Prev: Minor Mode for Buffers Visiting Files, Up: Miscellaneous
  231. 8.9 Minor Mode for Buffers Visiting Blobs
  232. =========================================
  233. The ‘magit-blob-mode’ enables certain Magit features in blob-visiting
  234. buffers. Such buffers can be created using ‘magit-find-file’ and some
  235. of the commands mentioned below, which also take care of turning on this
  236. minor mode. Currently this mode only establishes a few key bindings,
  237. but this might be extended.
  238. ‘p’ (‘magit-blob-previous’)
  239. Visit the previous blob which modified the current file.
  240. ‘n’ (‘magit-blob-next’)
  241. Visit the next blob which modified the current file.
  242. ‘q’ (‘magit-kill-this-buffer’)
  243. Kill the current buffer.
  244. 
  245. File: magit.info, Node: Customizing, Next: Plumbing, Prev: Miscellaneous, Up: Top
  246. 9 Customizing
  247. *************
  248. Both Git and Emacs are highly customizable. Magit is both a Git
  249. porcelain as well as an Emacs package, so it makes sense to customize it
  250. using both Git variables as well as Emacs options. However this
  251. flexibility doesn’t come without problems, including but not limited to
  252. the following.
  253. • Some Git variables automatically have an effect in Magit without
  254. requiring any explicit support. Sometimes that is desirable - in
  255. other cases, it breaks Magit.
  256. When a certain Git setting breaks Magit but you want to keep using
  257. that setting on the command line, then that can be accomplished by
  258. overriding the value for Magit only by appending something like
  259. ‘("-c" "some.variable=compatible-value")’ to
  260. ‘magit-git-global-arguments’.
  261. • Certain settings like ‘fetch.prune=true’ are respected by Magit
  262. commands (because they simply call the respective Git command) but
  263. their value is not reflected in the respective transient buffers.
  264. In this case the ‘--prune’ argument in ‘magit-fetch’ might be
  265. active or inactive, but that doesn’t keep the Git variable from
  266. being honored by the suffix commands anyway. So pruning might
  267. happen despite the ‘--prune’ arguments being displayed in a way
  268. that seems to indicate that no pruning will happen.
  269. I intend to address these and similar issues in a future release.
  270. * Menu:
  271. * Per-Repository Configuration::
  272. * Essential Settings::
  273. 
  274. File: magit.info, Node: Per-Repository Configuration, Next: Essential Settings, Up: Customizing
  275. 9.1 Per-Repository Configuration
  276. ================================
  277. Magit can be configured on a per-repository level using both Git
  278. variables as well as Emacs options.
  279. To set a Git variable for one repository only, simply set it in
  280. ‘/path/to/repo/.git/config’ instead of ‘$HOME/.gitconfig’ or
  281. ‘/etc/gitconfig’. See *note (gitman)git-config::.
  282. Similarly, Emacs options can be set for one repository only by
  283. editing ‘/path/to/repo/.dir-locals.el’. See *note (emacs)Directory
  284. Variables::. For example to disable automatic refreshes of
  285. file-visiting buffers in just one huge repository use this:
  286. • ‘/path/to/huge/repo/.dir-locals.el’
  287. ((nil . ((magit-refresh-buffers . nil))))
  288. If you want to apply the same settings to several, but not all,
  289. repositories then keeping the repository-local config files in sync
  290. would quickly become annoying. To avoid that you can create config
  291. files for certain classes of repositories (e.g. "huge repositories")
  292. and then include those files in the per-repository config files. For
  293. example:
  294. • ‘/path/to/huge/repo/.git/config’
  295. [include]
  296. path = /path/to/huge-gitconfig
  297. • ‘/path/to/huge-gitconfig’
  298. [status]
  299. showUntrackedFiles = no
  300. • ‘$HOME/.emacs.d/init.el’
  301. (dir-locals-set-class-variables 'huge-git-repository
  302. '((nil . ((magit-refresh-buffers . nil)))))
  303. (dir-locals-set-directory-class
  304. "/path/to/huge/repo/" 'huge-git-repository)
  305. 
  306. File: magit.info, Node: Essential Settings, Prev: Per-Repository Configuration, Up: Customizing
  307. 9.2 Essential Settings
  308. ======================
  309. The next two sections list and discuss several variables that many users
  310. might want to customize, for safety and/or performance reasons.
  311. * Menu:
  312. * Safety::
  313. * Performance::
  314. 
  315. File: magit.info, Node: Safety, Next: Performance, Up: Essential Settings
  316. 9.2.1 Safety
  317. ------------
  318. This section discusses various variables that you might want to change
  319. (or *not* change) for safety reasons.
  320. Git keeps *committed* changes around long enough for users to recover
  321. changes they have accidentally been deleted. It does not do the same
  322. for *uncommitted* changes in the working tree and not even the index
  323. (the staging area). Because Magit makes it so easy to modify
  324. uncommitted changes, it also makes it easy to shoot yourself in the foot
  325. in the process. For that reason Magit provides three global modes that
  326. save *tracked* files to work-in-progress references after or before
  327. certain actions. See *note Wip Modes::.
  328. These modes are not enabled by default because of performance
  329. concerns. Instead a lot of potentially destructive commands require
  330. confirmation every time they are used. In many cases this can be
  331. disabled by adding a symbol to ‘magit-no-confirm’ (see *note Completion
  332. and Confirmation::). If you enable the various wip modes then you
  333. should add ‘safe-with-wip’ to this list.
  334. Similarly it isn’t necessary to require confirmation before moving a
  335. file to the system trash - if you trashed a file by mistake then you can
  336. recover it from the there. Option ‘magit-delete-by-moving-to-trash’
  337. controls whether the system trash is used, which is the case by default.
  338. Nevertheless, ‘trash’ isn’t a member of ‘magit-no-confirm’ - you might
  339. want to change that.
  340. By default buffers visiting files are automatically reverted when the
  341. visited file changes on disk. This isn’t as risky as it might seem, but
  342. to make an informed decision you should see *note Risk of Reverting
  343. Automatically::.
  344. 
  345. File: magit.info, Node: Performance, Prev: Safety, Up: Essential Settings
  346. 9.2.2 Performance
  347. -----------------
  348. After Magit has run ‘git’ for side-effects, it also refreshes the
  349. current Magit buffer and the respective status buffer. This is
  350. necessary because otherwise outdated information might be displayed
  351. without the user noticing. Magit buffers are updated by recreating
  352. their content from scratch, which makes updating simpler and less
  353. error-prone, but also more costly. Keeping it simple and just
  354. re-creating everything from scratch is an old design decision and
  355. departing from that will require major refactoring.
  356. I plan to do that in time for the next major release. I also intend
  357. to create logs and diffs asynchronously, which should also help a lot
  358. but also requires major refactoring.
  359. Meanwhile you can tell Magit to only automatically refresh the
  360. current Magit buffer, but not the status buffer. If you do that, then
  361. the status buffer is only refreshed automatically if it is the current
  362. buffer.
  363. (setq magit-refresh-status-buffer nil)
  364. You should also check whether any third-party packages have added
  365. anything to ‘magit-refresh-buffer-hook’, ‘magit-status-refresh-hook’,
  366. ‘magit-pre-refresh-hook’, and ‘magit-post-refresh-hook’. If so, then
  367. check whether those additions impact performance significantly. Setting
  368. ‘magit-refresh-verbose’ and then inspecting the output in the
  369. ‘*Messages*’ buffer, should help doing so.
  370. Magit also reverts buffers for visited files located inside the
  371. current repository when the visited file changes on disk. That is
  372. implemented on top of ‘auto-revert-mode’ from the built-in library
  373. ‘autorevert’. To figure out whether that impacts performance, check
  374. whether performance is significantly worse, when many buffers exist
  375. and/or when some buffers visit files using TRAMP. If so, then this
  376. should help.
  377. (setq auto-revert-buffer-list-filter
  378. 'magit-auto-revert-repository-buffer-p)
  379. For alternative approaches see *note Automatic Reverting of
  380. File-Visiting Buffers::.
  381. If you have enabled any features that are disabled by default, then
  382. you should check whether they impact performance significantly. It’s
  383. likely that they were not enabled by default because it is known that
  384. they reduce performance at least in large repositories.
  385. If performance is only slow inside certain unusually large
  386. repositories, then you might want to disable certain features on a
  387. per-repository or per-repository-class basis only. See *note
  388. Per-Repository Configuration::.
  389. * Menu:
  390. * Microsoft Windows Performance::
  391. * MacOS Performance::
  392. Log Performance
  393. ...............
  394. When showing logs, Magit limits the number of commits initially shown in
  395. the hope that this avoids unnecessary work. When using ‘--graph’ is
  396. used, then this unfortunately does not have the desired effect for large
  397. histories. Junio, Git’s maintainer, said on the git mailing list
  398. (<http://www.spinics.net/lists/git/msg232230.html>): "‘--graph’ wants to
  399. compute the whole history and the max-count only affects the output
  400. phase after ‘--graph’ does its computation".
  401. In other words, it’s not that Git is slow at outputting the
  402. differences, or that Magit is slow at parsing the output - the problem
  403. is that Git first goes outside and has a smoke.
  404. We actually work around this issue by limiting the number of commits
  405. not only by using ‘-<N>’ but by also using a range. But unfortunately
  406. that’s not always possible.
  407. When more than a few thousand commits are shown, then the use of
  408. ‘--graph’ can slow things down.
  409. Using ‘--color --graph’ is even slower. Magit uses code that is part
  410. of Emacs to turn control characters into faces. That code is pretty
  411. slow and this is quite noticeable when showing a log with many branches
  412. and merges. For that reason ‘--color’ is not enabled by default
  413. anymore. Consider leaving it at that.
  414. Diff Performance
  415. ................
  416. If diffs are slow, then consider turning off some optional diff features
  417. by setting all or some of the following variables to ‘nil’:
  418. ‘magit-diff-highlight-indentation’, ‘magit-diff-highlight-trailing’,
  419. ‘magit-diff-paint-whitespace’, ‘magit-diff-highlight-hunk-body’, and
  420. ‘magit-diff-refine-hunk’.
  421. When showing a commit instead of some arbitrary diff, then some
  422. additional information is displayed. Calculating this information can
  423. be quite expensive given certain circumstances. If looking at a commit
  424. using ‘magit-revision-mode’ takes considerably more time than looking at
  425. the same commit in ‘magit-diff-mode’, then consider setting
  426. ‘magit-revision-insert-related-refs’ to ‘nil’.
  427. Refs Buffer Performance
  428. .......................
  429. When refreshing the "references buffer" is slow, then that’s usually
  430. because several hundred refs are being displayed. The best way to
  431. address that is to display fewer refs, obviously.
  432. If you are not, or only mildly, interested in seeing the list of
  433. tags, then start by not displaying them:
  434. (remove-hook 'magit-refs-sections-hook 'magit-insert-tags)
  435. Then you should also make sure that the listed remote branches
  436. actually all exist. You can do so by pruning branches which no longer
  437. exist using ‘f-pa’.
  438. Committing Performance
  439. ......................
  440. When you initiate a commit, then Magit by default automatically shows a
  441. diff of the changes you are about to commit. For large commits this can
  442. take a long time, which is especially distracting when you are
  443. committing large amounts of generated data which you don’t actually
  444. intend to inspect before committing. This behavior can be turned off
  445. using:
  446. (remove-hook 'server-switch-hook 'magit-commit-diff)
  447. Then you can type ‘C-c C-d’ to show the diff when you actually want
  448. to see it, but only then. Alternatively you can leave the hook alone
  449. and just type ‘C-g’ in those cases when it takes too long to generate
  450. the diff. If you do that, then you will end up with a broken diff
  451. buffer, but doing it this way has the advantage that you usually get to
  452. see the diff, which is useful because it increases the odds that you
  453. spot potential issues.
  454. The Built-In VC Package
  455. .......................
  456. Emacs comes with a version control interface called "VC", see *note
  457. (emacs)Version Control::. It is enabled be default, and if you don’t
  458. use it in addition to Magit, then you should disable it to keep it from
  459. performing unnecessary work:
  460. (setq vc-handled-backends nil)
  461. You can also disable its use for Git but keep using it when using
  462. another version control system:
  463. (setq vc-handled-backends (delq 'Git vc-handled-backends))
  464. 
  465. File: magit.info, Node: Microsoft Windows Performance, Next: MacOS Performance, Up: Performance
  466. Microsoft Windows Performance
  467. .............................
  468. In order to update the status buffer, ‘git’ has to be run a few dozen
  469. times. That is problematic on Microsoft Windows, because that operating
  470. system is exceptionally slow at starting processes. Sadly this is an
  471. issue that can only be fixed by Microsoft itself, and they don’t appear
  472. to be particularly interested in doing so.
  473. Beside the subprocess issue, there are also other Windows-specific
  474. performance issues. Some of these have workarounds. The maintainers of
  475. "Git for Windows" try to improve performance on Windows. Always use the
  476. latest release in order to benefit from the latest performance tweaks.
  477. Magit too tries to work around some Windows-specific issues.
  478. According to some sources, setting the following Git variables can
  479. also help.
  480. git config --global core.preloadindex true # default since v2.1
  481. git config --global core.fscache true # default since v2.8
  482. git config --global gc.auto 256
  483. You should also check whether an anti-virus program is affecting
  484. performance.
  485. 
  486. File: magit.info, Node: MacOS Performance, Prev: Microsoft Windows Performance, Up: Performance
  487. MacOS Performance
  488. .................
  489. On macOS Emacs currently creates child processes using ‘fork’. It
  490. appears that this also copies GUI resources. The result is that forking
  491. takes about 30 times as long on Darwin than on Linux. And because Magit
  492. starts many ‘git’ processes even when doing simple things, that makes
  493. quite a difference.
  494. On the ‘master’ branch Emacs now uses ‘vfork’ when possible, like
  495. this was already done on Linux, and now child creation only takes about
  496. twice as long on Darwin. See (1) for more information.
  497. Nobody knows when the changes on the ‘master’ branch will be released
  498. as ‘26.1’, but it is still a long way off. You might want to get your
  499. hands on this change before then. The easiest way to get a patched
  500. Emacs is to install the ‘emacs-plus’ formula (2) using ‘homebrew’. The
  501. change has been backported, so you get it not only when using ‘--HEAD’,
  502. but also when using ‘--devel’ or when installing the latest release (by
  503. not using a version argument).
  504. Alternatively you can apply the backport (3) manually.
  505. ---------- Footnotes ----------
  506. (1)
  507. <https://lists.gnu.org/archive/html/bug-gnu-emacs/2017-04/msg00201.html>
  508. (2) <https://github.com/d12frosted/homebrew-emacs-plus>
  509. (3)
  510. <https://gist.githubusercontent.com/aaronjensen/f45894ddf431ecbff78b1bcf533d3e6b/raw/6a5cd7f57341aba673234348d8b0d2e776f86719/Emacs-25-OS-X-use-vfork.patch>
  511. 
  512. File: magit.info, Node: Plumbing, Next: FAQ, Prev: Customizing, Up: Top
  513. 10 Plumbing
  514. ***********
  515. The following sections describe how to use several of Magit’s core
  516. abstractions to extend Magit itself or implement a separate extension.
  517. A few of the low-level features used by Magit have been factored out
  518. into separate libraries/packages, so that they can be used by other
  519. packages, without having to depend on Magit. See *note
  520. (with-editor)Top:: for information about ‘with-editor’. ‘transient’
  521. doesn’t have a manual yet.
  522. If you are trying to find an unused key that you can bind to a
  523. command provided by your own Magit extension, then checkout
  524. <https://github.com/magit/magit/wiki/Plugin-Dispatch-Key-Registry>.
  525. * Menu:
  526. * Calling Git::
  527. * Section Plumbing::
  528. * Refreshing Buffers::
  529. * Conventions::
  530. 
  531. File: magit.info, Node: Calling Git, Next: Section Plumbing, Up: Plumbing
  532. 10.1 Calling Git
  533. ================
  534. Magit provides many specialized functions for calling Git. All of these
  535. functions are defined in either ‘magit-git.el’ or ‘magit-process.el’ and
  536. have one of the prefixes ‘magit-run-’, ‘magit-call-’, ‘magit-start-’, or
  537. ‘magit-git-’ (which is also used for other things).
  538. All of these functions accept an indefinite number of arguments,
  539. which are strings that specify command line arguments for Git (or in
  540. some cases an arbitrary executable). These arguments are flattened
  541. before being passed on to the executable; so instead of strings they can
  542. also be lists of strings and arguments that are ‘nil’ are silently
  543. dropped. Some of these functions also require a single mandatory
  544. argument before these command line arguments.
  545. Roughly speaking, these functions run Git either to get some value or
  546. for side-effects. The functions that return a value are useful to
  547. collect the information necessary to populate a Magit buffer, while the
  548. others are used to implement Magit commands.
  549. The functions in the value-only group always run synchronously, and
  550. they never trigger a refresh. The function in the side-effect group can
  551. be further divided into subgroups depending on whether they run Git
  552. synchronously or asynchronously, and depending on whether they trigger a
  553. refresh when the executable has finished.
  554. * Menu:
  555. * Getting a Value from Git::
  556. * Calling Git for Effect::
  557. 
  558. File: magit.info, Node: Getting a Value from Git, Next: Calling Git for Effect, Up: Calling Git
  559. 10.1.1 Getting a Value from Git
  560. -------------------------------
  561. These functions run Git in order to get a value, an exit status, or
  562. output. Of course you could also use them to run Git commands that have
  563. side-effects, but that should be avoided.
  564. -- Function: magit-git-exit-code &rest args
  565. Executes git with ARGS and returns its exit code.
  566. -- Function: magit-git-success &rest args
  567. Executes git with ARGS and returns ‘t’ if the exit code is ‘0’,
  568. ‘nil’ otherwise.
  569. -- Function: magit-git-failure &rest args
  570. Executes git with ARGS and returns ‘t’ if the exit code is ‘1’,
  571. ‘nil’ otherwise.
  572. -- Function: magit-git-true &rest args
  573. Executes git with ARGS and returns ‘t’ if the first line printed by
  574. git is the string "true", ‘nil’ otherwise.
  575. -- Function: magit-git-false &rest args
  576. Executes git with ARGS and returns ‘t’ if the first line printed by
  577. git is the string "false", ‘nil’ otherwise.
  578. -- Function: magit-git-insert &rest args
  579. Executes git with ARGS and inserts its output at point.
  580. -- Function: magit-git-string &rest args
  581. Executes git with ARGS and returns the first line of its output.
  582. If there is no output or if it begins with a newline character,
  583. then this returns ‘nil’.
  584. -- Function: magit-git-lines &rest args
  585. Executes git with ARGS and returns its output as a list of lines.
  586. Empty lines anywhere in the output are omitted.
  587. -- Function: magit-git-items &rest args
  588. Executes git with ARGS and returns its null-separated output as a
  589. list. Empty items anywhere in the output are omitted.
  590. If the value of option ‘magit-git-debug’ is non-nil and git exits
  591. with a non-zero exit status, then warn about that in the echo area
  592. and add a section containing git’s standard error in the current
  593. repository’s process buffer.
  594. If an error occurs when using one of the above functions, then that
  595. is usually due to a bug, i.e. using an argument which is not actually
  596. supported. Such errors are usually not reported, but when they occur we
  597. need to be able to debug them.
  598. -- User Option: magit-git-debug
  599. Whether to report errors that occur when using ‘magit-git-insert’,
  600. ‘magit-git-string’, ‘magit-git-lines’, or ‘magit-git-items’. This
  601. does not actually raise an error. Instead a message is shown in
  602. the echo area, and git’s standard error is insert into a new
  603. section in the current repository’s process buffer.
  604. -- Function: magit-git-str &rest args
  605. This is a variant of ‘magit-git-string’ that ignores the option
  606. ‘magit-git-debug’. It is mainly intended to be used while handling
  607. errors in functions that do respect that option. Using such a
  608. function while handing an error could cause yet another error and
  609. therefore lead to an infinite recursion. You probably won’t ever
  610. need to use this function.
  611. 
  612. File: magit.info, Node: Calling Git for Effect, Prev: Getting a Value from Git, Up: Calling Git
  613. 10.1.2 Calling Git for Effect
  614. -----------------------------
  615. These functions are used to run git to produce some effect. Most Magit
  616. commands that actually run git do so by using such a function.
  617. Because we do not need to consume git’s output when using these
  618. functions, their output is instead logged into a per-repository buffer,
  619. which can be shown using ‘$’ from a Magit buffer or ‘M-x magit-process’
  620. elsewhere.
  621. These functions can have an effect in two distinct ways. Firstly,
  622. running git may change something, i.e. create or push a new commit.
  623. Secondly, that change may require that Magit buffers are refreshed to
  624. reflect the changed state of the repository. But refreshing isn’t
  625. always desirable, so only some of these functions do perform such a
  626. refresh after git has returned.
  627. Sometimes it is useful to run git asynchronously. For example, when
  628. the user has just initiated a push, then there is no reason to make her
  629. wait until that has completed. In other cases it makes sense to wait
  630. for git to complete before letting the user do something else. For
  631. example after staging a change it is useful to wait until after the
  632. refresh because that also automatically moves to the next change.
  633. -- Function: magit-call-git &rest args
  634. Calls git synchronously with ARGS.
  635. -- Function: magit-call-process program &rest args
  636. Calls PROGRAM synchronously with ARGS.
  637. -- Function: magit-run-git &rest args
  638. Calls git synchronously with ARGS and then refreshes.
  639. -- Function: magit-run-git-with-input input &rest args
  640. Calls git synchronously with ARGS and sends it INPUT on standard
  641. input.
  642. INPUT should be a buffer or the name of an existing buffer. The
  643. content of that buffer is used as the process’ standard input.
  644. After the process returns a refresh is performed.
  645. As a special case, INPUT may also be nil. In that case the content
  646. of the current buffer is used as standard input and *no* refresh is
  647. performed.
  648. This function actually runs git asynchronously. But then it waits
  649. for the process to return, so the function itself is synchronous.
  650. -- Function: magit-run-git-with-logfile file &rest args
  651. Calls git synchronously with ARGS. The process’ output is saved in
  652. FILE. This is rarely useful and so this function might be removed
  653. in the future.
  654. This function actually runs git asynchronously. But then it waits
  655. for the process to return, so the function itself is synchronous.
  656. -- Function: magit-git &rest args
  657. Calls git synchronously with ARGS for side-effects only. This
  658. function does not refresh the buffer.
  659. -- Function: magit-git-wash washer &rest args
  660. Execute Git with ARGS, inserting washed output at point. Actually
  661. first insert the raw output at point. If there is no output call
  662. ‘magit-cancel-section’. Otherwise temporarily narrow the buffer to
  663. the inserted text, move to its beginning, and then call function
  664. WASHER with ARGS as its sole argument.
  665. And now for the asynchronous variants.
  666. -- Function: magit-run-git-async &rest args
  667. Start Git, prepare for refresh, and return the process object.
  668. ARGS is flattened and then used as arguments to Git.
  669. Display the command line arguments in the echo area.
  670. After Git returns some buffers are refreshed: the buffer that was
  671. current when this function was called (if it is a Magit buffer and
  672. still alive), as well as the respective Magit status buffer.
  673. Unmodified buffers visiting files that are tracked in the current
  674. repository are reverted if ‘magit-revert-buffers’ is non-nil.
  675. -- Function: magit-run-git-with-editor &rest args
  676. Export GIT_EDITOR and start Git. Also prepare for refresh and
  677. return the process object. ARGS is flattened and then used as
  678. arguments to Git.
  679. Display the command line arguments in the echo area.
  680. After Git returns some buffers are refreshed: the buffer that was
  681. current when this function was called (if it is a Magit buffer and
  682. still alive), as well as the respective Magit status buffer.
  683. -- Function: magit-start-git &rest args
  684. Start Git, prepare for refresh, and return the process object.
  685. If INPUT is non-nil, it has to be a buffer or the name of an
  686. existing buffer. The buffer content becomes the processes standard
  687. input.
  688. Option ‘magit-git-executable’ specifies the Git executable and
  689. option ‘magit-git-global-arguments’ specifies constant arguments.
  690. The remaining arguments ARGS specify arguments to Git. They are
  691. flattened before use.
  692. After Git returns, some buffers are refreshed: the buffer that was
  693. current when this function was called (if it is a Magit buffer and
  694. still alive), as well as the respective Magit status buffer.
  695. Unmodified buffers visiting files that are tracked in the current
  696. repository are reverted if ‘magit-revert-buffers’ is non-nil.
  697. -- Function: magit-start-process &rest args
  698. Start PROGRAM, prepare for refresh, and return the process object.
  699. If optional argument INPUT is non-nil, it has to be a buffer or the
  700. name of an existing buffer. The buffer content becomes the
  701. processes standard input.
  702. The process is started using ‘start-file-process’ and then setup to
  703. use the sentinel ‘magit-process-sentinel’ and the filter
  704. ‘magit-process-filter’. Information required by these functions is
  705. stored in the process object. When this function returns the
  706. process has not started to run yet so it is possible to override
  707. the sentinel and filter.
  708. After the process returns, ‘magit-process-sentinel’ refreshes the
  709. buffer that was current when ‘magit-start-process’ was called (if
  710. it is a Magit buffer and still alive), as well as the respective
  711. Magit status buffer. Unmodified buffers visiting files that are
  712. tracked in the current repository are reverted if
  713. ‘magit-revert-buffers’ is non-nil.
  714. -- Variable: magit-this-process
  715. The child process which is about to start. This can be used to
  716. change the filter and sentinel.
  717. -- Variable: magit-process-raise-error
  718. When this is non-nil, then ‘magit-process-sentinel’ raises an error
  719. if git exits with a non-zero exit status. For debugging purposes.
  720. 
  721. File: magit.info, Node: Section Plumbing, Next: Refreshing Buffers, Prev: Calling Git, Up: Plumbing
  722. 10.2 Section Plumbing
  723. =====================
  724. * Menu:
  725. * Creating Sections::
  726. * Section Selection::
  727. * Matching Sections::
  728. 
  729. File: magit.info, Node: Creating Sections, Next: Section Selection, Up: Section Plumbing
  730. 10.2.1 Creating Sections
  731. ------------------------
  732. -- Macro: magit-insert-section &rest args
  733. Insert a section at point.
  734. TYPE is the section type, a symbol. Many commands that act on the
  735. current section behave differently depending on that type. Also if
  736. a variable ‘magit-TYPE-section-map’ exists, then use that as the
  737. text-property ‘keymap’ of all text belonging to the section (but
  738. this may be overwritten in subsections). TYPE can also have the
  739. form ‘(eval FORM)’ in which case FORM is evaluated at runtime.
  740. Optional VALUE is the value of the section, usually a string that
  741. is required when acting on the section.
  742. When optional HIDE is non-nil collapse the section body by default,
  743. i.e. when first creating the section, but not when refreshing the
  744. buffer. Otherwise, expand it by default. This can be overwritten
  745. using ‘magit-section-set-visibility-hook’. When a section is
  746. recreated during a refresh, then the visibility of predecessor is
  747. inherited and HIDE is ignored (but the hook is still honored).
  748. BODY is any number of forms that actually insert the section’s
  749. heading and body. Optional NAME, if specified, has to be a symbol,
  750. which is then bound to the struct of the section being inserted.
  751. Before BODY is evaluated the ‘start’ of the section object is set
  752. to the value of ‘point’ and after BODY was evaluated its ‘end’ is
  753. set to the new value of ‘point’; BODY is responsible for moving
  754. ‘point’ forward.
  755. If it turns out inside BODY that the section is empty, then
  756. ‘magit-cancel-section’ can be used to abort and remove all traces
  757. of the partially inserted section. This can happen when creating a
  758. section by washing Git’s output and Git didn’t actually output
  759. anything this time around.
  760. -- Function: magit-insert-heading &rest args
  761. Insert the heading for the section currently being inserted.
  762. This function should only be used inside ‘magit-insert-section’.
  763. When called without any arguments, then just set the ‘content’ slot
  764. of the object representing the section being inserted to a marker
  765. at ‘point’. The section should only contain a single line when
  766. this function is used like this.
  767. When called with arguments ARGS, which have to be strings, then
  768. insert those strings at point. The section should not contain any
  769. text before this happens and afterwards it should again only
  770. contain a single line. If the ‘face’ property is set anywhere
  771. inside any of these strings, then insert all of them unchanged.
  772. Otherwise use the ‘magit-section-heading’ face for all inserted
  773. text.
  774. The ‘content’ property of the section struct is the end of the
  775. heading (which lasts from ‘start’ to ‘content’) and the beginning
  776. of the body (which lasts from ‘content’ to ‘end’). If the value of
  777. ‘content’ is nil, then the section has no heading and its body
  778. cannot be collapsed. If a section does have a heading then its
  779. height must be exactly one line, including a trailing newline
  780. character. This isn’t enforced; you are responsible for getting it
  781. right. The only exception is that this function does insert a
  782. newline character if necessary.
  783. -- Function: magit-cancel-section
  784. Cancel the section currently being inserted. This exits the
  785. innermost call to ‘magit-insert-section’ and removes all traces of
  786. what has already happened inside that call.
  787. -- Function: magit-define-section-jumper sym title &optional value
  788. Define an interactive function to go to section SYM. TITLE is the
  789. displayed title of the section.
  790. 
  791. File: magit.info, Node: Section Selection, Next: Matching Sections, Prev: Creating Sections, Up: Section Plumbing
  792. 10.2.2 Section Selection
  793. ------------------------
  794. -- Function: magit-current-section
  795. Return the section at point.
  796. -- Function: magit-region-sections &optional condition multiple
  797. Return a list of the selected sections.
  798. When the region is active and constitutes a valid section
  799. selection, then return a list of all selected sections. This is
  800. the case when the region begins in the heading of a section and
  801. ends in the heading of the same section or in that of a sibling
  802. section. If optional MULTIPLE is non-nil, then the region cannot
  803. begin and end in the same section.
  804. When the selection is not valid, then return nil. In this case,
  805. most commands that can act on the selected sections will instead
  806. act on the section at point.
  807. When the region looks like it would in any other buffer then the
  808. selection is invalid. When the selection is valid then the region
  809. uses the ‘magit-section-highlight’ face. This does not apply to
  810. diffs where things get a bit more complicated, but even here if the
  811. region looks like it usually does, then that’s not a valid
  812. selection as far as this function is concerned.
  813. If optional CONDITION is non-nil, then the selection not only has
  814. to be valid; all selected sections additionally have to match
  815. CONDITION, or nil is returned. See ‘magit-section-match’ for the
  816. forms CONDITION can take.
  817. -- Function: magit-region-values &optional condition multiple
  818. Return a list of the values of the selected sections.
  819. Return the values that themselves would be returned by
  820. ‘magit-region-sections’ (which see).
  821. 
  822. File: magit.info, Node: Matching Sections, Prev: Section Selection, Up: Section Plumbing
  823. 10.2.3 Matching Sections
  824. ------------------------
  825. ‘M-x magit-describe-section-briefly’ (‘magit-describe-section-briefly’)
  826. Show information about the section at point. This command is
  827. intended for debugging purposes.
  828. -- Function: magit-section-ident section
  829. Return an unique identifier for SECTION. The return value has the
  830. form ‘((TYPE . VALUE)...)’.
  831. -- Function: magit-get-section ident &optional root
  832. Return the section identified by IDENT. IDENT has to be a list as
  833. returned by ‘magit-section-ident’.
  834. -- Function: magit-section-match condition &optional section
  835. Return ‘t’ if SECTION matches CONDITION. SECTION defaults to the
  836. section at point. If SECTION is not specified and there also is no
  837. section at point, then return ‘nil’.
  838. CONDITION can take the following forms:
  839. • ‘(CONDITION...)’
  840. matches if any of the CONDITIONs matches.
  841. • ‘[CLASS...]’
  842. matches if the section’s class is the same as the first CLASS
  843. or a subclass of that; the section’s parent class matches the
  844. second CLASS; and so on.
  845. • ‘[* CLASS...]’
  846. matches sections that match ‘[CLASS...]’ and also recursively
  847. all their child sections.
  848. • ‘CLASS’
  849. matches if the section’s class is the same as CLASS or a
  850. subclass of that; regardless of the classes of the parent
  851. sections.
  852. Each CLASS should be a class symbol, identifying a class that
  853. derives from ‘magit-section’. For backward compatibility CLASS can
  854. also be a "type symbol". A section matches such a symbol if the
  855. value of its ‘type’ slot is ‘eq’. If a type symbol has an entry in
  856. ‘magit--section-type-alist’, then a section also matches that type
  857. if its class is a subclass of the class that corresponds to the
  858. type as per that alist.
  859. Note that it is not necessary to specify the complete section
  860. lineage as printed by ‘magit-describe-section-briefly’, unless of
  861. course you want to be that precise.
  862. -- Function: magit-section-value-if condition &optional section
  863. If the section at point matches CONDITION, then return its value.
  864. If optional SECTION is non-nil then test whether that matches
  865. instead. If there is no section at point and SECTION is nil, then
  866. return nil. If the section does not match, then return nil.
  867. See ‘magit-section-match’ for the forms CONDITION can take.
  868. -- Function: magit-section-case &rest clauses
  869. Choose among clauses on the type of the section at point.
  870. Each clause looks like (CONDITION BODY...). The type of the
  871. section is compared against each CONDITION; the BODY forms of the
  872. first match are evaluated sequentially and the value of the last
  873. form is returned. Inside BODY the symbol ‘it’ is bound to the
  874. section at point. If no clause succeeds or if there is no section
  875. at point return nil.
  876. See ‘magit-section-match’ for the forms CONDITION can take.
  877. Additionally a CONDITION of t is allowed in the final clause and
  878. matches if no other CONDITION match, even if there is no section at
  879. point.
  880. -- Variable: magit-root-section
  881. The root section in the current buffer. All other sections are
  882. descendants of this section. The value of this variable is set by
  883. ‘magit-insert-section’ and you should never modify it.
  884. For diff related sections a few additional tools exist.
  885. -- Function: magit-diff-type &optional section
  886. Return the diff type of SECTION.
  887. The returned type is one of the symbols ‘staged’, ‘unstaged’,
  888. ‘committed’, or ‘undefined’. This type serves a similar purpose as
  889. the general type common to all sections (which is stored in the
  890. ‘type’ slot of the corresponding ‘magit-section’ struct) but takes
  891. additional information into account. When the SECTION isn’t
  892. related to diffs and the buffer containing it also isn’t a
  893. diff-only buffer, then return nil.
  894. Currently the type can also be one of ‘tracked’ and ‘untracked’,
  895. but these values are not handled explicitly in every place they
  896. should be. A possible fix could be to just return nil here.
  897. The section has to be a ‘diff’ or ‘hunk’ section, or a section
  898. whose children are of type ‘diff’. If optional SECTION is nil,
  899. return the diff type for the current section. In buffers whose
  900. major mode is ‘magit-diff-mode’ SECTION is ignored and the type is
  901. determined using other means. In ‘magit-revision-mode’ buffers the
  902. type is always ‘committed’.
  903. -- Function: magit-diff-scope &optional section strict
  904. Return the diff scope of SECTION or the selected section(s).
  905. A diff’s "scope" describes what part of a diff is selected, it is a
  906. symbol, one of ‘region’, ‘hunk’, ‘hunks’, ‘file’, ‘files’, or
  907. ‘list’. Do not confuse this with the diff "type", as returned by
  908. ‘magit-diff-type’.
  909. If optional SECTION is non-nil, then return the scope of that,
  910. ignoring the sections selected by the region. Otherwise return the
  911. scope of the current section, or if the region is active and
  912. selects a valid group of diff related sections, the type of these
  913. sections, i.e. ‘hunks’ or ‘files’. If SECTION (or if the current
  914. section that is nil) is a ‘hunk’ section and the region starts and
  915. ends inside the body of a that section, then the type is ‘region’.
  916. If optional STRICT is non-nil then return nil if the diff type of
  917. the section at point is ‘untracked’ or the section at point is not
  918. actually a ‘diff’ but a ‘diffstat’ section.
  919. 
  920. File: magit.info, Node: Refreshing Buffers, Next: Conventions, Prev: Section Plumbing, Up: Plumbing
  921. 10.3 Refreshing Buffers
  922. =======================
  923. All commands that create a new Magit buffer or change what is being
  924. displayed in an existing buffer do so by calling ‘magit-mode-setup’.
  925. Among other things, that function sets the buffer local values of
  926. ‘default-directory’ (to the top-level of the repository),
  927. ‘magit-refresh-function’, and ‘magit-refresh-args’.
  928. Buffers are refreshed by calling the function that is the local value
  929. of ‘magit-refresh-function’ (a function named ‘magit-*-refresh-buffer’,
  930. where ‘*’ may be something like ‘diff’) with the value of
  931. ‘magit-refresh-args’ as arguments.
  932. -- Macro: magit-mode-setup buffer switch-func mode refresh-func
  933. &optional refresh-args
  934. This function displays and selects BUFFER, turns on MODE, and
  935. refreshes a first time.
  936. This function displays and optionally selects BUFFER by calling
  937. ‘magit-mode-display-buffer’ with BUFFER, MODE and SWITCH-FUNC as
  938. arguments. Then it sets the local value of
  939. ‘magit-refresh-function’ to REFRESH-FUNC and that of
  940. ‘magit-refresh-args’ to REFRESH-ARGS. Finally it creates the
  941. buffer content by calling REFRESH-FUNC with REFRESH-ARGS as
  942. arguments.
  943. All arguments are evaluated before switching to BUFFER.
  944. -- Function: magit-mode-display-buffer buffer mode &optional
  945. switch-function
  946. This function display BUFFER in some window and select it. BUFFER
  947. may be a buffer or a string, the name of a buffer. The buffer is
  948. returned.
  949. Unless BUFFER is already displayed in the selected frame, store the
  950. previous window configuration as a buffer local value, so that it
  951. can later be restored by ‘magit-mode-bury-buffer’.
  952. The buffer is displayed and selected using SWITCH-FUNCTION. If
  953. that is ‘nil’ then ‘pop-to-buffer’ is used if the current buffer’s
  954. major mode derives from ‘magit-mode’. Otherwise ‘switch-to-buffer’
  955. is used.
  956. -- Variable: magit-refresh-function
  957. The value of this buffer-local variable is the function used to
  958. refresh the current buffer. It is called with ‘magit-refresh-args’
  959. as arguments.
  960. -- Variable: magit-refresh-args
  961. The list of arguments used by ‘magit-refresh-function’ to refresh
  962. the current buffer. ‘magit-refresh-function’ is called with these
  963. arguments.
  964. The value is usually set using ‘magit-mode-setup’, but in some
  965. cases it’s also useful to provide commands that can change the
  966. value. For example, the ‘magit-diff-refresh’ transient can be used
  967. to change any of the arguments used to display the diff, without
  968. having to specify again which differences should be shown, but
  969. ‘magit-diff-more-context’, ‘magit-diff-less-context’ and
  970. ‘magit-diff-default-context’ change just the ‘-U<N>’ argument. In
  971. both case this is done by changing the value of this variable and
  972. then calling this ‘magit-refresh-function’.
  973. 
  974. File: magit.info, Node: Conventions, Prev: Refreshing Buffers, Up: Plumbing
  975. 10.4 Conventions
  976. ================
  977. Also see *note Completion and Confirmation::.
  978. * Menu:
  979. * Theming Faces::
  980. 
  981. File: magit.info, Node: Theming Faces, Up: Conventions
  982. 10.4.1 Theming Faces
  983. --------------------
  984. The default theme uses blue for local branches, green for remote
  985. branches, and goldenrod (brownish yellow) for tags. When creating a new
  986. theme, you should probably follow that example. If your theme already
  987. uses other colors, then stick to that.
  988. In older releases these reference faces used to have a background
  989. color and a box around them. The basic default faces no longer do so,
  990. to make Magit buffers much less noisy, and you should follow that
  991. example at least with regards to boxes. (Boxes were used in the past to
  992. work around a conflict between the highlighting overlay and text
  993. property backgrounds. That’s no longer necessary because highlighting
  994. no longer causes other background colors to disappear.) Alternatively
  995. you can keep the background color and/or box, but then have to take
  996. special care to adjust ‘magit-branch-current’ accordingly. By default
  997. it looks mostly like ‘magit-branch-local’, but with a box (by default
  998. the former is the only face that uses a box, exactly so that it sticks
  999. out). If the former also uses a box, then you have to make sure that it
  1000. differs in some other way from the latter.
  1001. The most difficult faces to theme are those related to diffs,
  1002. headings, highlighting, and the region. There are faces that fall into
  1003. all four groups - expect to spend some time getting this right.
  1004. The ‘region’ face in the default theme, in both the light and dark
  1005. variants, as well as in many other themes, distributed with Emacs or by
  1006. third-parties, is very ugly. It is common to use a background color
  1007. that really sticks out, which is ugly but if that were the only problem
  1008. then it would be acceptable. Unfortunately many themes also set the
  1009. foreground color, which ensures that all text within the region is
  1010. readable. Without doing that there might be cases where some foreground
  1011. color is too close to the region background color to still be readable.
  1012. But it also means that text within the region loses all syntax
  1013. highlighting.
  1014. I consider the work that went into getting the ‘region’ face right to
  1015. be a good indicator for the general quality of a theme. My
  1016. recommendation for the ‘region’ face is this: use a background color
  1017. slightly different from the background color of the ‘default’ face, and
  1018. do not set the foreground color at all. So for a light theme you might
  1019. use a light (possibly tinted) gray as the background color of ‘default’
  1020. and a somewhat darker gray for the background of ‘region’. That should
  1021. usually be enough to not collide with the foreground color of any other
  1022. face. But if some other faces also set a light gray as background
  1023. color, then you should also make sure it doesn’t collide with those (in
  1024. some cases it might be acceptable though).
  1025. Magit only uses the ‘region’ face when the region is "invalid" by its
  1026. own definition. In a Magit buffer the region is used to either select
  1027. multiple sibling sections, so that commands which support it act on all
  1028. of these sections instead of just the current section, or to select
  1029. lines within a single hunk section. In all other cases, the section is
  1030. considered invalid and Magit won’t act on it. But such invalid sections
  1031. happen, either because the user has not moved point enough yet to make
  1032. it valid or because she wants to use a non-magit command to act on the
  1033. region, e.g. ‘kill-region’.
  1034. So using the regular ‘region’ face for invalid sections is a feature.
  1035. It tells the user that Magit won’t be able to act on it. It’s
  1036. acceptable if that face looks a bit odd and even (but less so) if it
  1037. collides with the background colors of section headings and other things
  1038. that have a background color.
  1039. Magit highlights the current section. If a section has subsections,
  1040. then all of them are highlighted. This is done using faces that have
  1041. "highlight" in their names. For most sections,
  1042. ‘magit-section-highlight’ is used for both the body and the heading.
  1043. Like the ‘region’ face, it should only set the background color to
  1044. something similar to that of ‘default’. The highlight background color
  1045. must be different from both the ‘region’ background color and the
  1046. ‘default’ background color.
  1047. For diff related sections Magit uses various faces to highlight
  1048. different parts of the selected section(s). Note that hunk headings,
  1049. unlike all other section headings, by default have a background color,
  1050. because it is useful to have very visible separators between hunks.
  1051. That face ‘magit-diff-hunk-heading’, should be different from both
  1052. ‘magit-diff-hunk-heading-highlight’ and ‘magit-section-highlight’, as
  1053. well as from ‘magit-diff-context’ and ‘magit-diff-context-highlight’.
  1054. By default we do that by changing the foreground color. Changing the
  1055. background color would lead to complications, and there are already
  1056. enough we cannot get around. (Also note that it is generally a good
  1057. idea for section headings to always be bold, but only for sections that
  1058. have subsections).
  1059. When there is a valid region selecting diff-related sibling sections,
  1060. i.e. multiple files or hunks, then the bodies of all these sections use
  1061. the respective highlight faces, but additionally the headings instead
  1062. use one of the faces ‘magit-diff-file-heading-selection’ or
  1063. ‘magit-diff-hunk-heading-selection’. These faces have to be different
  1064. from the regular highlight variants to provide explicit visual
  1065. indication that the region is active.
  1066. When theming diff related faces, start by setting the option
  1067. ‘magit-diff-refine-hunk’ to ‘all’. You might personally prefer to only
  1068. refine the current hunk or not use hunk refinement at all, but some of
  1069. the users of your theme want all hunks to be refined, so you have to
  1070. cater to that.
  1071. (Also turn on ‘magit-diff-highlight-indentation’,
  1072. ‘magit-diff-highlight-trailing’, and ‘magit-diff-paint-whitespace’; and
  1073. insert some whitespace errors into the code you use for testing.)
  1074. For e.g. "added lines" you have to adjust three faces:
  1075. ‘magit-diff-added’, ‘magit-diff-added-highlight’, and
  1076. ‘smerge-refined-added’. Make sure that the latter works well with both
  1077. of the former, as well as ‘smerge-other’ and ‘diff-added’. Then do the
  1078. same for the removed lines, context lines, lines added by us, and lines
  1079. added by them. Also make sure the respective added, removed, and
  1080. context faces use approximately the same saturation for both the
  1081. highlighted and unhighlighted variants. Also make sure the file and
  1082. diff headings work nicely with context lines (e.g. make them look
  1083. different). Line faces should set both the foreground and the
  1084. background color. For example, for added lines use two different
  1085. greens.
  1086. It’s best if the foreground color of both the highlighted and the
  1087. unhighlighted variants are the same, so you will need to have to find a
  1088. color that works well on the highlight and unhighlighted background, the
  1089. refine background, and the highlight context background. When there is
  1090. an hunk internal region, then the added- and removed-lines background
  1091. color is used only within that region. Outside the region the
  1092. highlighted context background color is used. This makes it easier to
  1093. see what is being staged. With an hunk internal region the hunk heading
  1094. is shown using ‘magit-diff-hunk-heading-selection’, and so are the thin
  1095. lines that are added around the lines that fall within the region. The
  1096. background color of that has to be distinct enough from the various
  1097. other involved background colors.
  1098. Nobody said this would be easy. If your theme restricts itself to a
  1099. certain set of colors, then you should make an exception here.
  1100. Otherwise it would be impossible to make the diffs look good in each and
  1101. every variation. Actually you might want to just stick to the default
  1102. definitions for these faces. You have been warned. Also please note
  1103. that if you do not get this right, this will in some cases look to users
  1104. like bugs in Magit - so please do it right or not at all.
  1105. 
  1106. File: magit.info, Node: FAQ, Next: Debugging Tools, Prev: Plumbing, Up: Top
  1107. Appendix A FAQ
  1108. **************
  1109. The next two nodes lists frequently asked questions. For a list of
  1110. frequently *and recently* asked questions, i.e. questions that haven’t
  1111. made it into the manual yet, see
  1112. <https://github.com/magit/magit/wiki/FAQ>.
  1113. Please also use the *note Debugging Tools::.
  1114. * Menu:
  1115. * FAQ - How to ...?::
  1116. * FAQ - Issues and Errors::
  1117. 
  1118. File: magit.info, Node: FAQ - How to ...?, Next: FAQ - Issues and Errors, Up: FAQ
  1119. A.1 FAQ - How to ...?
  1120. =====================
  1121. * Menu:
  1122. * How to show git's output?::
  1123. * How to install the gitman info manual?::
  1124. * How to show diffs for gpg-encrypted files?::
  1125. * How does branching and pushing work?::
  1126. * Can Magit be used as ediff-version-control-package?::
  1127. 
  1128. File: magit.info, Node: How to show git's output?, Next: How to install the gitman info manual?, Up: FAQ - How to ...?
  1129. A.1.1 How to show git’s output?
  1130. -------------------------------
  1131. To show the output of recently run git commands, press ‘$’ (or, if that
  1132. isn’t available, ‘M-x magit-process-buffer’). This will show a buffer
  1133. containing a section per git invocation; as always press ‘TAB’ to expand
  1134. or collapse them.
  1135. By default, git’s output is only inserted into the process buffer if
  1136. it is run for side-effects. When the output is consumed in some way,
  1137. also inserting it into the process buffer would be too expensive. For
  1138. debugging purposes, it’s possible to do so anyway by setting
  1139. ‘magit-git-debug’ to ‘t’.
  1140. 
  1141. File: magit.info, Node: How to install the gitman info manual?, Next: How to show diffs for gpg-encrypted files?, Prev: How to show git's output?, Up: FAQ - How to ...?
  1142. A.1.2 How to install the gitman info manual?
  1143. --------------------------------------------
  1144. Git’s manpages can be exported as an info manual called ‘gitman’.
  1145. Magit’s own info manual links to nodes in that manual instead of the
  1146. actual manpages because Info doesn’t support linking to manpages.
  1147. Unfortunately some distributions do not install the ‘gitman’ manual
  1148. by default and you will have to install a separate documentation package
  1149. to get it.
  1150. Magit patches Info adding the ability to visit links to the ‘gitman’
  1151. Info manual by instead viewing the respective manpage. If you prefer
  1152. that approach, then set the value of ‘magit-view-git-manual-method’ to
  1153. one of the supported packages ‘man’ or ‘woman’, e.g.:
  1154. (setq magit-view-git-manual-method 'man)
  1155. 
  1156. File: magit.info, Node: How to show diffs for gpg-encrypted files?, Next: How does branching and pushing work?, Prev: How to install the gitman info manual?, Up: FAQ - How to ...?
  1157. A.1.3 How to show diffs for gpg-encrypted files?
  1158. ------------------------------------------------
  1159. Git supports showing diffs for encrypted files, but has to be told to do
  1160. so. Since Magit just uses Git to get the diffs, configuring Git also
  1161. affects the diffs displayed inside Magit.
  1162. git config --global diff.gpg.textconv "gpg --no-tty --decrypt"
  1163. echo "*.gpg filter=gpg diff=gpg" > .gitattributes
  1164. 
  1165. File: magit.info, Node: How does branching and pushing work?, Next: Can Magit be used as ediff-version-control-package?, Prev: How to show diffs for gpg-encrypted files?, Up: FAQ - How to ...?
  1166. A.1.4 How does branching and pushing work?
  1167. ------------------------------------------
  1168. Please see *note Branching:: and
  1169. <http://emacsair.me/2016/01/17/magit-2.4>
  1170. 
  1171. File: magit.info, Node: Can Magit be used as ediff-version-control-package?, Prev: How does branching and pushing work?, Up: FAQ - How to ...?
  1172. A.1.5 Can Magit be used as ‘ediff-version-control-package’?
  1173. -----------------------------------------------------------
  1174. No, it cannot. For that to work the functions ‘ediff-magit-internal’
  1175. and ‘ediff-magit-merge-internal’ would have to be implemented, and they
  1176. are not. These two functions are only used by the three commands
  1177. ‘ediff-revision’, ‘ediff-merge-revisions-with-ancestor’, and
  1178. ‘ediff-merge-revisions’.
  1179. These commands only delegate the task of populating buffers with
  1180. certain revisions to the "internal" functions. The equally important
  1181. task of determining which revisions are to be compared/merged is not
  1182. delegated. Instead this is done without any support whatsoever from the
  1183. version control package/system - meaning that the user has to enter the
  1184. revisions explicitly. Instead of implementing ‘ediff-magit-internal’ we
  1185. provide ‘magit-ediff-compare’, which handles both tasks like it is 2005.
  1186. The other commands ‘ediff-merge-revisions’ and
  1187. ‘ediff-merge-revisions-with-ancestor’ are normally not what you want
  1188. when using a modern version control system like Git. Instead of letting
  1189. the user resolve only those conflicts which Git could not resolve on its
  1190. own, they throw away all work done by Git and then expect the user to
  1191. manually merge all conflicts, including those that had already been
  1192. resolved. That made sense back in the days when version control systems
  1193. couldn’t merge (or so I have been told), but not anymore. Once in a
  1194. blue moon you might actually want to see all conflicts, in which case
  1195. you *can* use these commands, which then use ‘ediff-vc-merge-internal’.
  1196. So we don’t actually have to implement ‘ediff-magit-merge-internal’.
  1197. Instead we provide the more useful command ‘magit-ediff-resolve’ which
  1198. only shows yet-to-be resolved conflicts.
  1199. 
  1200. File: magit.info, Node: FAQ - Issues and Errors, Prev: FAQ - How to ...?, Up: FAQ
  1201. A.2 FAQ - Issues and Errors
  1202. ===========================
  1203. * Menu:
  1204. * Magit is slow::
  1205. * I changed several thousand files at once and now Magit is unusable::
  1206. * I am having problems committing::
  1207. * I am using MS Windows and cannot push with Magit::
  1208. * I am using OS X and SOMETHING works in shell, but not in Magit: I am using OS X and SOMETHING works in shell but not in Magit.
  1209. * Diffs contain control sequences::
  1210. * Expanding a file to show the diff causes it to disappear::
  1211. * Point is wrong in the COMMIT_EDITMSG buffer::
  1212. * The mode-line information isn't always up-to-date::
  1213. * A branch and tag sharing the same name breaks SOMETHING::
  1214. * My Git hooks work on the command-line but not inside Magit::
  1215. * git-commit-mode isn't used when committing from the command-line::
  1216. * Point ends up inside invisible text when jumping to a file-visiting buffer::
  1217. 
  1218. File: magit.info, Node: Magit is slow, Next: I changed several thousand files at once and now Magit is unusable, Up: FAQ - Issues and Errors
  1219. A.2.1 Magit is slow
  1220. -------------------
  1221. See *note Performance::.
  1222. 
  1223. File: magit.info, Node: I changed several thousand files at once and now Magit is unusable, Next: I am having problems committing, Prev: Magit is slow, Up: FAQ - Issues and Errors
  1224. A.2.2 I changed several thousand files at once and now Magit is unusable
  1225. ------------------------------------------------------------------------
  1226. Magit is *currently* not expected to work under such conditions. It
  1227. sure would be nice if it did, and v2.5 will hopefully be a big step into
  1228. that direction. But it might take until v3.1 to accomplish fully
  1229. satisfactory performance, because that requires some heavy refactoring.
  1230. But for now we recommend you use the command line to complete this
  1231. one commit. Also see *note Performance::.
  1232. 
  1233. File: magit.info, Node: I am having problems committing, Next: I am using MS Windows and cannot push with Magit, Prev: I changed several thousand files at once and now Magit is unusable, Up: FAQ - Issues and Errors
  1234. A.2.3 I am having problems committing
  1235. -------------------------------------
  1236. That likely means that Magit is having problems finding an appropriate
  1237. emacsclient executable. See *note (with-editor)Configuring
  1238. With-Editor:: and *note (with-editor)Debugging::.
  1239. 
  1240. File: magit.info, Node: I am using MS Windows and cannot push with Magit, Next: I am using OS X and SOMETHING works in shell but not in Magit, Prev: I am having problems committing, Up: FAQ - Issues and Errors
  1241. A.2.4 I am using MS Windows and cannot push with Magit
  1242. ------------------------------------------------------
  1243. It’s almost certain that Magit is only incidental to this issue. It is
  1244. much more likely that this is a configuration issue, even if you can
  1245. push on the command line.
  1246. Detailed setup instructions can be found at
  1247. <https://github.com/magit/magit/wiki/Pushing-with-Magit-from-Windows>.
  1248. 
  1249. File: magit.info, Node: I am using OS X and SOMETHING works in shell but not in Magit, Next: Diffs contain control sequences, Prev: I am using MS Windows and cannot push with Magit, Up: FAQ - Issues and Errors
  1250. A.2.5 I am using OS X and SOMETHING works in shell, but not in Magit
  1251. --------------------------------------------------------------------
  1252. This usually occurs because Emacs doesn’t have the same environment
  1253. variables as your shell. Try installing and configuring
  1254. <https://github.com/purcell/exec-path-from-shell>. By default it
  1255. synchronizes ‘$PATH’, which helps Magit find the same ‘git’ as the one
  1256. you are using on the shell.
  1257. If SOMETHING is "passphrase caching with gpg-agent for commit and/or
  1258. tag signing", then you’ll also need to synchronize ‘$GPG_AGENT_INFO’.
  1259. 
  1260. File: magit.info, Node: Diffs contain control sequences, Next: Expanding a file to show the diff causes it to disappear, Prev: I am using OS X and SOMETHING works in shell but not in Magit, Up: FAQ - Issues and Errors
  1261. A.2.6 Diffs contain control sequences
  1262. -------------------------------------
  1263. This happens when you configure Git to always color diffs and/or all of
  1264. its output. The valid values for relevant Git variables ‘color.ui’ and
  1265. ‘color.diff’ are ‘false’, ‘true’ and ‘always’, and the default is
  1266. ‘true’. You should leave it that way because then you get colorful
  1267. output in terminals by default but when git’s output is consumed by
  1268. something else, then no color control sequences are used.
  1269. If you actually use some other tool that requires setting ‘color.ui’
  1270. and/or ‘color.diff’ to ‘always’ (which is highly unlikely), then you can
  1271. override these settings just for Magit by using:
  1272. (setq magit-git-global-arguments
  1273. (nconc magit-git-global-arguments
  1274. '("-c" "color.ui=false"
  1275. "-c" "color.diff=false")))
  1276. 
  1277. File: magit.info, Node: Expanding a file to show the diff causes it to disappear, Next: Point is wrong in the COMMIT_EDITMSG buffer, Prev: Diffs contain control sequences, Up: FAQ - Issues and Errors
  1278. A.2.7 Expanding a file to show the diff causes it to disappear
  1279. --------------------------------------------------------------
  1280. This is probably caused by a change of a ‘diff.*’ Git variable. You
  1281. probably set that variable for a reason, and should therefore only undo
  1282. that setting in Magit by customizing ‘magit-git-global-arguments’.
  1283. 
  1284. File: magit.info, Node: Point is wrong in the COMMIT_EDITMSG buffer, Next: The mode-line information isn't always up-to-date, Prev: Expanding a file to show the diff causes it to disappear, Up: FAQ - Issues and Errors
  1285. A.2.8 Point is wrong in the ‘COMMIT_EDITMSG’ buffer
  1286. ---------------------------------------------------
  1287. Neither Magit nor ‘git-commit‘ fiddle with point in the buffer used to
  1288. write commit messages, so something else must be doing it.
  1289. You have probably globally enabled a mode which does restore point in
  1290. file-visiting buffers. It might be a bit surprising, but when you write
  1291. a commit message, then you are actually editing a file.
  1292. So you have to figure out which package is doing. ‘saveplace’,
  1293. ‘pointback’, and ‘session’ are likely candidates. These snippets might
  1294. help:
  1295. (setq session-name-disable-regexp "\\(?:\\`'\\.git/[A-Z_]+\\'\\)")
  1296. (with-eval-after-load 'pointback
  1297. (lambda ()
  1298. (when (or git-commit-mode git-rebase-mode)
  1299. (pointback-mode -1))))
  1300. 
  1301. File: magit.info, Node: The mode-line information isn't always up-to-date, Next: A branch and tag sharing the same name breaks SOMETHING, Prev: Point is wrong in the COMMIT_EDITMSG buffer, Up: FAQ - Issues and Errors
  1302. A.2.9 The mode-line information isn’t always up-to-date
  1303. -------------------------------------------------------
  1304. Magit is not responsible for the version control information that is
  1305. being displayed in the mode-line and looks something like ‘Git-master’.
  1306. The built-in "Version Control" package, also known as "VC", updates that
  1307. information, and can be told to do so more often:
  1308. (setq auto-revert-check-vc-info t)
  1309. But doing so isn’t good for performance. For more (overly
  1310. optimistic) information see *note (emacs)VC Mode Line::.
  1311. If you don’t really care about seeing that information in the
  1312. mode-line, but just don’t want to see _incorrect_ information, then
  1313. consider disabling VC when using Git:
  1314. (setq vc-handled-backends (delq 'Git vc-handled-backends))
  1315. Or to disable it completely:
  1316. (setq vc-handled-backends nil)
  1317. 
  1318. File: magit.info, Node: A branch and tag sharing the same name breaks SOMETHING, Next: My Git hooks work on the command-line but not inside Magit, Prev: The mode-line information isn't always up-to-date, Up: FAQ - Issues and Errors
  1319. A.2.10 A branch and tag sharing the same name breaks SOMETHING
  1320. --------------------------------------------------------------
  1321. Or more generally, ambiguous refnames break SOMETHING.
  1322. Magit assumes that refs are named non-ambiguously across the
  1323. "refs/heads/", "refs/tags/", and "refs/remotes/" namespaces (i.e., all
  1324. the names remain unique when those prefixes are stripped). We consider
  1325. ambiguous refnames unsupported and recommend that you use a
  1326. non-ambiguous naming scheme. However, if you do work with a repository
  1327. that has ambiguous refnames, please report any issues you encounter so
  1328. that we can investigate whether there is a simple fix.
  1329. 
  1330. File: magit.info, Node: My Git hooks work on the command-line but not inside Magit, Next: git-commit-mode isn't used when committing from the command-line, Prev: A branch and tag sharing the same name breaks SOMETHING, Up: FAQ - Issues and Errors
  1331. A.2.11 My Git hooks work on the command-line but not inside Magit
  1332. -----------------------------------------------------------------
  1333. When Magit calls ‘git’ it adds a few global arguments including
  1334. ‘--literal-pathspecs’ and the ‘git’ process started by Magit then passes
  1335. that setting on to other ‘git’ process it starts itself. It does so by
  1336. setting the environment variable ‘GIT_LITERAL_PATHSPECS’, not by calling
  1337. subprocesses with the ‘--literal-pathspecs’. You can therefore override
  1338. this setting in hook scripts using ‘unset GIT_LITERAL_PATHSPECS’.
  1339. 
  1340. File: magit.info, Node: git-commit-mode isn't used when committing from the command-line, Next: Point ends up inside invisible text when jumping to a file-visiting buffer, Prev: My Git hooks work on the command-line but not inside Magit, Up: FAQ - Issues and Errors
  1341. A.2.12 ‘git-commit-mode’ isn’t used when committing from the command-line
  1342. -------------------------------------------------------------------------
  1343. The reason for this is that ‘git-commit.el’ has not been loaded yet
  1344. and/or that the server has not been started yet. These things have
  1345. always already been taken care of when you commit from Magit because in
  1346. order to do so, Magit has to be loaded and doing that involves loading
  1347. ‘git-commit’ and starting the server.
  1348. If you want to commit from the command-line, then you have to take
  1349. care of these things yourself. Your ‘init.el’ file should contain:
  1350. (require 'git-commit)
  1351. (server-mode)
  1352. Instead of ‘(require ’git-commit)‘ you may also use:
  1353. (load "/path/to/magit-autoloads.el")
  1354. You might want to do that because loading ‘git-commit’ causes large
  1355. parts of Magit to be loaded.
  1356. There are also some variations of ‘(server-mode)’ that you might want
  1357. to try. Personally I use:
  1358. (use-package server
  1359. :config (or (server-running-p) (server-mode)))
  1360. Now you can use:
  1361. $ emacs&
  1362. $ EDITOR=emacsclient git commit
  1363. However you cannot use:
  1364. $ killall emacs
  1365. $ EDITOR="emacsclient --alternate-editor emacs" git commit
  1366. This will actually end up using ‘emacs’, not ‘emacsclient’. If you
  1367. do this, then can still edit the commit message but ‘git-commit-mode’
  1368. won’t be used and you have to exit ‘emacs’ to finish the process.
  1369. Tautology ahead. If you want to be able to use ‘emacsclient’ to
  1370. connect to a running ‘emacs’ instance, even though no ‘emacs’ instance
  1371. is running, then you cannot use ‘emacsclient’ directly.
  1372. Instead you have to create a script that does something like this:
  1373. Try to use ‘emacsclient’ (without using ‘--alternate-editor’). If
  1374. that succeeds, do nothing else. Otherwise start ‘emacs &’ (and
  1375. ‘init.el’ must call ‘server-start’) and try to use ‘emacsclient’ again.
  1376. 
  1377. File: magit.info, Node: Point ends up inside invisible text when jumping to a file-visiting buffer, Prev: git-commit-mode isn't used when committing from the command-line, Up: FAQ - Issues and Errors
  1378. A.2.13 Point ends up inside invisible text when jumping to a file-visiting buffer
  1379. ---------------------------------------------------------------------------------
  1380. This can happen when you type ‘RET’ on a hunk to visit the respective
  1381. file at the respective position. One solution to this problem is to use
  1382. ‘global-reveal-mode’. It makes sure that text around point is always
  1383. visible. If that is too drastic for your taste, then you may instead
  1384. use ‘magit-diff-visit-file-hook’ to reveal the text, possibly using
  1385. ‘reveal-post-command’ or for Org buffers ‘org-reveal’.
  1386. 
  1387. File: magit.info, Node: Debugging Tools, Next: Keystroke Index, Prev: FAQ, Up: Top
  1388. B Debugging Tools
  1389. *****************
  1390. Magit and its dependencies provide a few debugging tools, and we
  1391. appreciate it very much if you use those tools before reporting an
  1392. issue. Please include all relevant output when reporting an issue.
  1393. ‘M-x magit-version’ (‘magit-version’)
  1394. This command shows the currently used versions of Magit, Git, and
  1395. Emacs in the echo area. Non-interactively this just returns the
  1396. Magit version.
  1397. ‘M-x magit-emacs-Q-command’ (‘magit-emacs-Q-command’)
  1398. This command shows a debugging shell command in the echo area and
  1399. adds it to the kill ring. Paste that command into a shell and run
  1400. it.
  1401. This shell command starts ‘emacs’ with only ‘magit’ and its
  1402. dependencies loaded. Neither your configuration nor other
  1403. installed packages are loaded. This makes it easier to determine
  1404. whether some issue lays with Magit or something else.
  1405. If you run Magit from its Git repository, then you should be able
  1406. to use ‘make emacs-Q’ instead of the output of this command.
  1407. ‘M-x magit-debug-git-executable’ (‘magit-debug-git-executable’)
  1408. This command displays a buffer containing information about the
  1409. available and used ‘git’ executable(s), and can be useful when
  1410. investigating ‘exec-path’ issues.
  1411. Also see *note Git Executable::.
  1412. ‘M-x with-editor-debug’ (‘with-editor-debug’)
  1413. This command displays a buffer containing information about the
  1414. available and used ‘~emacsclient’ executable(s), and can be useful
  1415. when investigating why Magit (or rather ‘with-editor’) cannot find
  1416. an appropriate ‘emacsclient’ executable.
  1417. Also see *note (with-editor)Debugging::.
  1418. Please also see the *note FAQ::.
  1419. 
  1420. File: magit.info, Node: Keystroke Index, Next: Command Index, Prev: Debugging Tools, Up: Top
  1421. Appendix C Keystroke Index
  1422. **************************
  1423. [index]
  1424. * Menu:
  1425. * !: Running Git Manually.
  1426. (line 12)
  1427. * ! !: Running Git Manually.
  1428. (line 17)
  1429. * ! a: Running Git Manually.
  1430. (line 58)
  1431. * ! b: Running Git Manually.
  1432. (line 62)
  1433. * ! g: Running Git Manually.
  1434. (line 66)
  1435. * ! k: Running Git Manually.
  1436. (line 54)
  1437. * ! p: Running Git Manually.
  1438. (line 25)
  1439. * ! s: Running Git Manually.
  1440. (line 35)
  1441. * ! S: Running Git Manually.
  1442. (line 40)
  1443. * $: Viewing Git Output. (line 16)
  1444. * %: Worktree. (line 8)
  1445. * % b: Worktree. (line 13)
  1446. * % c: Worktree. (line 17)
  1447. * % g: Worktree. (line 26)
  1448. * % k: Worktree. (line 21)
  1449. * +: Log Buffer. (line 61)
  1450. * + <1>: Refreshing Diffs. (line 69)
  1451. * -: Log Buffer. (line 65)
  1452. * - <1>: Refreshing Diffs. (line 65)
  1453. * 0: Refreshing Diffs. (line 73)
  1454. * 1: Section Visibility. (line 26)
  1455. * 2: Section Visibility. (line 27)
  1456. * 3: Section Visibility. (line 28)
  1457. * 4: Section Visibility. (line 29)
  1458. * =: Log Buffer. (line 55)
  1459. * ^: Section Movement. (line 31)
  1460. * a: Applying. (line 33)
  1461. * A: Cherry Picking. (line 8)
  1462. * A A: Cherry Picking. (line 17)
  1463. * A a: Cherry Picking. (line 24)
  1464. * A A <1>: Cherry Picking. (line 90)
  1465. * A a <1>: Cherry Picking. (line 98)
  1466. * A d: Cherry Picking. (line 54)
  1467. * A h: Cherry Picking. (line 42)
  1468. * A n: Cherry Picking. (line 65)
  1469. * A s: Cherry Picking. (line 76)
  1470. * A s <1>: Cherry Picking. (line 94)
  1471. * B: Bisecting. (line 8)
  1472. * b: Blaming. (line 105)
  1473. * b <1>: Branch Commands. (line 12)
  1474. * b <2>: Editing Rebase Sequences.
  1475. (line 85)
  1476. * B B: Bisecting. (line 16)
  1477. * B b: Bisecting. (line 31)
  1478. * b b: Branch Commands. (line 49)
  1479. * b C: Branch Commands. (line 29)
  1480. * b c: Branch Commands. (line 67)
  1481. * B g: Bisecting. (line 36)
  1482. * B k: Bisecting. (line 41)
  1483. * b k: Branch Commands. (line 147)
  1484. * b l: Branch Commands. (line 74)
  1485. * b n: Branch Commands. (line 57)
  1486. * B r: Bisecting. (line 47)
  1487. * b r: Branch Commands. (line 153)
  1488. * B s: Bisecting. (line 24)
  1489. * b s: Branch Commands. (line 97)
  1490. * b S: Branch Commands. (line 125)
  1491. * b x: Branch Commands. (line 131)
  1492. * c: Blaming. (line 138)
  1493. * C: Cloning Repository. (line 20)
  1494. * c <1>: Initiating a Commit. (line 8)
  1495. * c <2>: Editing Rebase Sequences.
  1496. (line 72)
  1497. * c a: Initiating a Commit. (line 19)
  1498. * c A: Initiating a Commit. (line 67)
  1499. * C b: Cloning Repository. (line 41)
  1500. * C C: Cloning Repository. (line 29)
  1501. * c c: Initiating a Commit. (line 14)
  1502. * C d: Cloning Repository. (line 54)
  1503. * C e: Cloning Repository. (line 61)
  1504. * c e: Initiating a Commit. (line 23)
  1505. * c f: Initiating a Commit. (line 43)
  1506. * c F: Initiating a Commit. (line 51)
  1507. * C m: Cloning Repository. (line 46)
  1508. * C s: Cloning Repository. (line 34)
  1509. * c s: Initiating a Commit. (line 55)
  1510. * c S: Initiating a Commit. (line 63)
  1511. * c w: Initiating a Commit. (line 33)
  1512. * C-<return>: Visiting Files and Blobs from a Diff.
  1513. (line 51)
  1514. * C-<tab>: Section Visibility. (line 13)
  1515. * C-c C-a: Editing Commit Messages.
  1516. (line 128)
  1517. * C-c C-b: Log Buffer. (line 21)
  1518. * C-c C-b <1>: Refreshing Diffs. (line 91)
  1519. * C-c C-c: Transient Commands. (line 18)
  1520. * C-c C-c <1>: Select from Log. (line 20)
  1521. * C-c C-c <2>: Editing Commit Messages.
  1522. (line 19)
  1523. * C-c C-c <3>: Editing Rebase Sequences.
  1524. (line 6)
  1525. * C-c C-d: Refreshing Diffs. (line 81)
  1526. * C-c C-d <1>: Editing Commit Messages.
  1527. (line 57)
  1528. * C-c C-e: Commands Available in Diffs.
  1529. (line 25)
  1530. * C-c C-f: Log Buffer. (line 25)
  1531. * C-c C-f <1>: Refreshing Diffs. (line 95)
  1532. * C-c C-i: Editing Commit Messages.
  1533. (line 153)
  1534. * C-c C-k: Select from Log. (line 26)
  1535. * C-c C-k <1>: Editing Commit Messages.
  1536. (line 24)
  1537. * C-c C-k <2>: Editing Rebase Sequences.
  1538. (line 11)
  1539. * C-c C-n: Log Buffer. (line 29)
  1540. * C-c C-o: Editing Commit Messages.
  1541. (line 144)
  1542. * C-c C-p: Editing Commit Messages.
  1543. (line 148)
  1544. * C-c C-r: Editing Commit Messages.
  1545. (line 132)
  1546. * C-c C-s: Editing Commit Messages.
  1547. (line 136)
  1548. * C-c C-t: Commands Available in Diffs.
  1549. (line 14)
  1550. * C-c C-t <1>: Editing Commit Messages.
  1551. (line 140)
  1552. * C-c C-w: Editing Commit Messages.
  1553. (line 63)
  1554. * C-c M-g: Minor Mode for Buffers Visiting Files.
  1555. (line 54)
  1556. * C-c M-g B: Blaming. (line 21)
  1557. * C-c M-g b: Blaming. (line 32)
  1558. * C-c M-g B <1>: Minor Mode for Buffers Visiting Files.
  1559. (line 123)
  1560. * C-c M-g B b: Blaming. (line 33)
  1561. * C-c M-g B e: Blaming. (line 67)
  1562. * C-c M-g B f: Blaming. (line 58)
  1563. * C-c M-g B r: Blaming. (line 49)
  1564. * C-c M-g c: Minor Mode for Buffers Visiting Files.
  1565. (line 68)
  1566. * C-c M-g D: Minor Mode for Buffers Visiting Files.
  1567. (line 75)
  1568. * C-c M-g d: Minor Mode for Buffers Visiting Files.
  1569. (line 86)
  1570. * C-c M-g e: Blaming. (line 66)
  1571. * C-c M-g e <1>: Minor Mode for Buffers Visiting Files.
  1572. (line 136)
  1573. * C-c M-g f: Blaming. (line 57)
  1574. * C-c M-g L: Minor Mode for Buffers Visiting Files.
  1575. (line 96)
  1576. * C-c M-g l: Minor Mode for Buffers Visiting Files.
  1577. (line 107)
  1578. * C-c M-g p: Minor Mode for Buffers Visiting Files.
  1579. (line 146)
  1580. * C-c M-g r: Blaming. (line 48)
  1581. * C-c M-g s: Minor Mode for Buffers Visiting Files.
  1582. (line 59)
  1583. * C-c M-g t: Minor Mode for Buffers Visiting Files.
  1584. (line 114)
  1585. * C-c M-g u: Minor Mode for Buffers Visiting Files.
  1586. (line 63)
  1587. * C-c M-s: Editing Commit Messages.
  1588. (line 35)
  1589. * C-w: Common Commands. (line 27)
  1590. * C-x g: Status Buffer. (line 22)
  1591. * C-x u: Editing Rebase Sequences.
  1592. (line 94)
  1593. * d: Diffing. (line 21)
  1594. * D: Refreshing Diffs. (line 11)
  1595. * d c: Diffing. (line 69)
  1596. * d d: Diffing. (line 27)
  1597. * D f: Refreshing Diffs. (line 46)
  1598. * D F: Refreshing Diffs. (line 51)
  1599. * D g: Refreshing Diffs. (line 17)
  1600. * d p: Diffing. (line 61)
  1601. * d r: Diffing. (line 31)
  1602. * D r: Refreshing Diffs. (line 41)
  1603. * d s: Diffing. (line 51)
  1604. * D s: Refreshing Diffs. (line 22)
  1605. * d t: Diffing. (line 74)
  1606. * D t: Refreshing Diffs. (line 37)
  1607. * d u: Diffing. (line 57)
  1608. * d w: Diffing. (line 45)
  1609. * D w: Refreshing Diffs. (line 29)
  1610. * DEL: Log Buffer. (line 45)
  1611. * DEL <1>: Commands Available in Diffs.
  1612. (line 60)
  1613. * DEL <2>: Blaming. (line 92)
  1614. * DEL <3>: Editing Rebase Sequences.
  1615. (line 28)
  1616. * e: Ediffing. (line 9)
  1617. * E: Ediffing. (line 21)
  1618. * e <1>: Editing Rebase Sequences.
  1619. (line 55)
  1620. * E c: Ediffing. (line 65)
  1621. * E i: Ediffing. (line 57)
  1622. * E m: Ediffing. (line 35)
  1623. * E r: Ediffing. (line 26)
  1624. * E s: Ediffing. (line 48)
  1625. * E u: Ediffing. (line 53)
  1626. * E w: Ediffing. (line 61)
  1627. * E z: Ediffing. (line 69)
  1628. * f: Editing Rebase Sequences.
  1629. (line 63)
  1630. * f <1>: Fetching. (line 9)
  1631. * F: Pulling. (line 9)
  1632. * f a: Fetching. (line 46)
  1633. * f C: Branch Commands. (line 30)
  1634. * F C: Branch Commands. (line 31)
  1635. * f e: Fetching. (line 32)
  1636. * F e: Pulling. (line 31)
  1637. * f m: Fetching. (line 50)
  1638. * f o: Fetching. (line 36)
  1639. * f p: Fetching. (line 15)
  1640. * F p: Pulling. (line 14)
  1641. * f r: Fetching. (line 41)
  1642. * f u: Fetching. (line 24)
  1643. * F u: Pulling. (line 23)
  1644. * g: Automatic Refreshing of Magit Buffers.
  1645. (line 24)
  1646. * G: Automatic Refreshing of Magit Buffers.
  1647. (line 33)
  1648. * j: Commands Available in Diffs.
  1649. (line 45)
  1650. * k: Viewing Git Output. (line 24)
  1651. * k <1>: Applying. (line 40)
  1652. * k <2>: Editing Rebase Sequences.
  1653. (line 68)
  1654. * k <3>: Stashing. (line 96)
  1655. * l: Logging. (line 29)
  1656. * L: Refreshing Logs. (line 11)
  1657. * L <1>: Log Buffer. (line 6)
  1658. * L <2>: Log Margin. (line 47)
  1659. * l <1>: Editing Rebase Sequences.
  1660. (line 115)
  1661. * l a: Logging. (line 60)
  1662. * l b: Logging. (line 56)
  1663. * L d: Log Margin. (line 64)
  1664. * L g: Refreshing Logs. (line 17)
  1665. * l h: Logging. (line 48)
  1666. * l H: Reflog. (line 19)
  1667. * l l: Logging. (line 35)
  1668. * l L: Logging. (line 52)
  1669. * L L: Log Margin. (line 56)
  1670. * L l: Log Margin. (line 60)
  1671. * l o: Logging. (line 41)
  1672. * l O: Reflog. (line 15)
  1673. * l r: Reflog. (line 11)
  1674. * L s: Refreshing Logs. (line 22)
  1675. * L t: Refreshing Logs. (line 37)
  1676. * L w: Refreshing Logs. (line 29)
  1677. * m: Merging. (line 9)
  1678. * M: Remote Commands. (line 13)
  1679. * m a: Merging. (line 45)
  1680. * m a <1>: Merging. (line 95)
  1681. * M a: Remote Commands. (line 50)
  1682. * M C: Remote Commands. (line 33)
  1683. * m e: Merging. (line 31)
  1684. * m i: Merging. (line 58)
  1685. * M k: Remote Commands. (line 65)
  1686. * m m: Merging. (line 18)
  1687. * m m <1>: Merging. (line 89)
  1688. * m n: Merging. (line 38)
  1689. * m p: Merging. (line 81)
  1690. * M p: Remote Commands. (line 69)
  1691. * M P: Remote Commands. (line 74)
  1692. * M r: Remote Commands. (line 55)
  1693. * m s: Merging. (line 72)
  1694. * M u: Remote Commands. (line 60)
  1695. * M-1: Section Visibility. (line 33)
  1696. * M-2: Section Visibility. (line 34)
  1697. * M-3: Section Visibility. (line 35)
  1698. * M-4: Section Visibility. (line 36)
  1699. * M-<tab>: Section Visibility. (line 17)
  1700. * M-n: Section Movement. (line 26)
  1701. * M-n <1>: Editing Commit Messages.
  1702. (line 45)
  1703. * M-n <2>: Editing Rebase Sequences.
  1704. (line 47)
  1705. * M-p: Section Movement. (line 20)
  1706. * M-p <1>: Editing Commit Messages.
  1707. (line 39)
  1708. * M-p <2>: Editing Rebase Sequences.
  1709. (line 43)
  1710. * M-w: Blaming. (line 130)
  1711. * M-w <1>: Common Commands. (line 10)
  1712. * M-x magit-debug-git-executable: Git Executable. (line 45)
  1713. * M-x magit-debug-git-executable <1>: Debugging Tools. (line 30)
  1714. * M-x magit-describe-section-briefly: Section Types and Values.
  1715. (line 13)
  1716. * M-x magit-describe-section-briefly <1>: Matching Sections. (line 6)
  1717. * M-x magit-emacs-Q-command: Debugging Tools. (line 16)
  1718. * M-x magit-init: Creating Repository. (line 6)
  1719. * M-x magit-reset-index: Staging and Unstaging.
  1720. (line 87)
  1721. * M-x magit-reverse-in-index: Staging and Unstaging.
  1722. (line 62)
  1723. * M-x magit-stage-file: Staging from File-Visiting Buffers.
  1724. (line 10)
  1725. * M-x magit-toggle-buffer-lock: Modes and Buffers. (line 17)
  1726. * M-x magit-unstage-file: Staging from File-Visiting Buffers.
  1727. (line 18)
  1728. * M-x magit-version: Git Executable. (line 17)
  1729. * M-x magit-version <1>: Debugging Tools. (line 10)
  1730. * M-x magit-wip-commit: Wip Modes. (line 88)
  1731. * M-x with-editor-debug: Debugging Tools. (line 38)
  1732. * MM: Editing Rebase Sequences.
  1733. (line 125)
  1734. * Mt: Editing Rebase Sequences.
  1735. (line 132)
  1736. * n: Section Movement. (line 16)
  1737. * n <1>: Blaming. (line 109)
  1738. * N: Blaming. (line 113)
  1739. * n <2>: Editing Rebase Sequences.
  1740. (line 39)
  1741. * n <3>: Minor Mode for Buffers Visiting Blobs.
  1742. (line 16)
  1743. * o: Submodule Transient. (line 6)
  1744. * O: Subtree. (line 8)
  1745. * o a: Submodule Transient. (line 20)
  1746. * o d: Submodule Transient. (line 50)
  1747. * O e: Subtree. (line 42)
  1748. * O e p: Subtree. (line 54)
  1749. * O e s: Subtree. (line 59)
  1750. * o f: Submodule Transient. (line 58)
  1751. * O i: Subtree. (line 13)
  1752. * O i a: Subtree. (line 25)
  1753. * O i c: Subtree. (line 30)
  1754. * O i f: Subtree. (line 38)
  1755. * O i m: Subtree. (line 34)
  1756. * o l: Submodule Transient. (line 54)
  1757. * o p: Submodule Transient. (line 34)
  1758. * o r: Submodule Transient. (line 27)
  1759. * o s: Submodule Transient. (line 44)
  1760. * o u: Submodule Transient. (line 39)
  1761. * p: Section Movement. (line 10)
  1762. * p <1>: Blaming. (line 117)
  1763. * P: Blaming. (line 121)
  1764. * p <2>: Editing Rebase Sequences.
  1765. (line 35)
  1766. * P <1>: Pushing. (line 9)
  1767. * p <3>: Minor Mode for Buffers Visiting Blobs.
  1768. (line 12)
  1769. * P C: Branch Commands. (line 32)
  1770. * P e: Pushing. (line 31)
  1771. * P m: Pushing. (line 50)
  1772. * P o: Pushing. (line 36)
  1773. * P p: Pushing. (line 15)
  1774. * P r: Pushing. (line 41)
  1775. * P t: Pushing. (line 58)
  1776. * P T: Pushing. (line 66)
  1777. * P u: Pushing. (line 23)
  1778. * q: Quitting Windows. (line 6)
  1779. * q <1>: Log Buffer. (line 14)
  1780. * q <2>: Blaming. (line 125)
  1781. * q <3>: Minor Mode for Buffers Visiting Blobs.
  1782. (line 20)
  1783. * r: Rebasing. (line 9)
  1784. * r <1>: Editing Rebase Sequences.
  1785. (line 51)
  1786. * r a: Rebasing. (line 124)
  1787. * r e: Rebasing. (line 45)
  1788. * r e <1>: Rebasing. (line 119)
  1789. * r f: Rebasing. (line 85)
  1790. * r i: Rebasing. (line 81)
  1791. * r k: Rebasing. (line 100)
  1792. * r m: Rebasing. (line 90)
  1793. * r p: Rebasing. (line 28)
  1794. * r r: Rebasing. (line 107)
  1795. * r s: Rebasing. (line 51)
  1796. * r s <1>: Rebasing. (line 114)
  1797. * r u: Rebasing. (line 37)
  1798. * r w: Rebasing. (line 95)
  1799. * RET: References Buffer. (line 179)
  1800. * RET <1>: Visiting Files and Blobs from a Diff.
  1801. (line 8)
  1802. * RET <2>: Blaming. (line 78)
  1803. * RET <3>: Editing Rebase Sequences.
  1804. (line 16)
  1805. * s: Staging and Unstaging.
  1806. (line 28)
  1807. * S: Staging and Unstaging.
  1808. (line 36)
  1809. * s <1>: Editing Rebase Sequences.
  1810. (line 59)
  1811. * S-<tab>: Section Visibility. (line 22)
  1812. * SPC: Log Buffer. (line 35)
  1813. * SPC <1>: Commands Available in Diffs.
  1814. (line 56)
  1815. * SPC <2>: Blaming. (line 82)
  1816. * SPC <3>: Editing Rebase Sequences.
  1817. (line 21)
  1818. * t: Editing Rebase Sequences.
  1819. (line 119)
  1820. * t <1>: Tagging. (line 8)
  1821. * T: Notes. (line 8)
  1822. * T a: Notes. (line 52)
  1823. * T c: Notes. (line 47)
  1824. * t k: Tagging. (line 40)
  1825. * T m: Notes. (line 38)
  1826. * t p: Tagging. (line 47)
  1827. * T p: Notes. (line 30)
  1828. * t r: Tagging. (line 19)
  1829. * T r: Notes. (line 22)
  1830. * t t: Tagging. (line 14)
  1831. * T T: Notes. (line 14)
  1832. * TAB: Section Visibility. (line 9)
  1833. * u: Staging and Unstaging.
  1834. (line 43)
  1835. * U: Staging and Unstaging.
  1836. (line 52)
  1837. * v: Applying. (line 44)
  1838. * V: Reverting. (line 6)
  1839. * V A: Reverting. (line 31)
  1840. * V a: Reverting. (line 39)
  1841. * V s: Reverting. (line 35)
  1842. * V V: Reverting. (line 15)
  1843. * V v: Reverting. (line 21)
  1844. * W: Plain Patches. (line 6)
  1845. * w: Maildir Patches. (line 8)
  1846. * w a: Plain Patches. (line 21)
  1847. * w a <1>: Maildir Patches. (line 25)
  1848. * w a <2>: Maildir Patches. (line 43)
  1849. * W c: Plain Patches. (line 12)
  1850. * w m: Maildir Patches. (line 21)
  1851. * W s: Plain Patches. (line 28)
  1852. * w s: Maildir Patches. (line 38)
  1853. * w w: Maildir Patches. (line 14)
  1854. * w w <1>: Maildir Patches. (line 34)
  1855. * x: Editing Rebase Sequences.
  1856. (line 76)
  1857. * x <1>: Resetting. (line 8)
  1858. * X f: Resetting. (line 44)
  1859. * X h: Resetting. (line 26)
  1860. * X i: Resetting. (line 31)
  1861. * X m: Resetting. (line 15)
  1862. * X s: Resetting. (line 20)
  1863. * X w: Resetting. (line 38)
  1864. * X w <1>: Wip Modes. (line 66)
  1865. * Y: Cherries. (line 17)
  1866. * y: References Buffer. (line 6)
  1867. * y <1>: Editing Rebase Sequences.
  1868. (line 90)
  1869. * y c: References Buffer. (line 26)
  1870. * y o: References Buffer. (line 32)
  1871. * y y: References Buffer. (line 21)
  1872. * z: Stashing. (line 8)
  1873. * z a: Stashing. (line 59)
  1874. * z b: Stashing. (line 81)
  1875. * z B: Stashing. (line 86)
  1876. * z f: Stashing. (line 92)
  1877. * z i: Stashing. (line 21)
  1878. * z I: Stashing. (line 47)
  1879. * z k: Stashing. (line 72)
  1880. * z l: Stashing. (line 100)
  1881. * z p: Stashing. (line 65)
  1882. * z v: Stashing. (line 77)
  1883. * z w: Stashing. (line 26)
  1884. * z W: Stashing. (line 52)
  1885. * z x: Stashing. (line 33)
  1886. * z z: Stashing. (line 14)
  1887. * z Z: Stashing. (line 40)
  1888. 
  1889. File: magit.info, Node: Command Index, Next: Function Index, Prev: Keystroke Index, Up: Top
  1890. Appendix D Command Index
  1891. ************************
  1892. [index]
  1893. * Menu:
  1894. * forward-line: Editing Rebase Sequences.
  1895. (line 39)
  1896. * git-commit-ack: Editing Commit Messages.
  1897. (line 128)
  1898. * git-commit-cc: Editing Commit Messages.
  1899. (line 144)
  1900. * git-commit-next-message: Editing Commit Messages.
  1901. (line 45)
  1902. * git-commit-prev-message: Editing Commit Messages.
  1903. (line 39)
  1904. * git-commit-reported: Editing Commit Messages.
  1905. (line 148)
  1906. * git-commit-review: Editing Commit Messages.
  1907. (line 132)
  1908. * git-commit-save-message: Editing Commit Messages.
  1909. (line 35)
  1910. * git-commit-signoff: Editing Commit Messages.
  1911. (line 136)
  1912. * git-commit-suggested: Editing Commit Messages.
  1913. (line 153)
  1914. * git-commit-test: Editing Commit Messages.
  1915. (line 140)
  1916. * git-rebase-backward-line: Editing Rebase Sequences.
  1917. (line 35)
  1918. * git-rebase-break: Editing Rebase Sequences.
  1919. (line 85)
  1920. * git-rebase-edit: Editing Rebase Sequences.
  1921. (line 55)
  1922. * git-rebase-exec: Editing Rebase Sequences.
  1923. (line 76)
  1924. * git-rebase-fixup: Editing Rebase Sequences.
  1925. (line 63)
  1926. * git-rebase-insert: Editing Rebase Sequences.
  1927. (line 90)
  1928. * git-rebase-kill-line: Editing Rebase Sequences.
  1929. (line 68)
  1930. * git-rebase-label: Editing Rebase Sequences.
  1931. (line 115)
  1932. * git-rebase-merge: Editing Rebase Sequences.
  1933. (line 125)
  1934. * git-rebase-merge-toggle-editmsg: Editing Rebase Sequences.
  1935. (line 132)
  1936. * git-rebase-move-line-down: Editing Rebase Sequences.
  1937. (line 47)
  1938. * git-rebase-move-line-up: Editing Rebase Sequences.
  1939. (line 43)
  1940. * git-rebase-pick: Editing Rebase Sequences.
  1941. (line 72)
  1942. * git-rebase-reset: Editing Rebase Sequences.
  1943. (line 119)
  1944. * git-rebase-reword: Editing Rebase Sequences.
  1945. (line 51)
  1946. * git-rebase-show-commit: Editing Rebase Sequences.
  1947. (line 16)
  1948. * git-rebase-show-or-scroll-down: Editing Rebase Sequences.
  1949. (line 28)
  1950. * git-rebase-show-or-scroll-up: Editing Rebase Sequences.
  1951. (line 21)
  1952. * git-rebase-squash: Editing Rebase Sequences.
  1953. (line 59)
  1954. * git-rebase-undo: Editing Rebase Sequences.
  1955. (line 94)
  1956. * ido-enter-magit-status: Status Buffer. (line 72)
  1957. * magit-am: Maildir Patches. (line 8)
  1958. * magit-am-abort: Maildir Patches. (line 43)
  1959. * magit-am-apply-maildir: Maildir Patches. (line 21)
  1960. * magit-am-apply-patches: Maildir Patches. (line 14)
  1961. * magit-am-continue: Maildir Patches. (line 34)
  1962. * magit-am-skip: Maildir Patches. (line 38)
  1963. * magit-apply: Applying. (line 33)
  1964. * magit-bisect: Bisecting. (line 8)
  1965. * magit-bisect-bad: Bisecting. (line 31)
  1966. * magit-bisect-good: Bisecting. (line 36)
  1967. * magit-bisect-reset: Bisecting. (line 47)
  1968. * magit-bisect-run: Bisecting. (line 24)
  1969. * magit-bisect-skip: Bisecting. (line 41)
  1970. * magit-bisect-start: Bisecting. (line 16)
  1971. * magit-blame: Blaming. (line 21)
  1972. * magit-blame <1>: Blaming. (line 105)
  1973. * magit-blame <2>: Minor Mode for Buffers Visiting Files.
  1974. (line 123)
  1975. * magit-blame-addition: Blaming. (line 32)
  1976. * magit-blame-addition <1>: Blaming. (line 33)
  1977. * magit-blame-copy-hash: Blaming. (line 130)
  1978. * magit-blame-cycle-style: Blaming. (line 138)
  1979. * magit-blame-echo: Blaming. (line 66)
  1980. * magit-blame-echo <1>: Blaming. (line 67)
  1981. * magit-blame-next-chunk: Blaming. (line 109)
  1982. * magit-blame-next-chunk-same-commit: Blaming. (line 113)
  1983. * magit-blame-previous-chunk: Blaming. (line 117)
  1984. * magit-blame-previous-chunk-same-commit: Blaming. (line 121)
  1985. * magit-blame-quit: Blaming. (line 125)
  1986. * magit-blame-removal: Blaming. (line 48)
  1987. * magit-blame-removal <1>: Blaming. (line 49)
  1988. * magit-blame-reverse: Blaming. (line 57)
  1989. * magit-blame-reverse <1>: Blaming. (line 58)
  1990. * magit-blob-next: Minor Mode for Buffers Visiting Blobs.
  1991. (line 16)
  1992. * magit-blob-previous: Minor Mode for Buffers Visiting Files.
  1993. (line 146)
  1994. * magit-blob-previous <1>: Minor Mode for Buffers Visiting Blobs.
  1995. (line 12)
  1996. * magit-branch: Branch Commands. (line 12)
  1997. * magit-branch-and-checkout: Branch Commands. (line 67)
  1998. * magit-branch-checkout: Branch Commands. (line 74)
  1999. * magit-branch-configure: Branch Commands. (line 29)
  2000. * magit-branch-configure <1>: Branch Commands. (line 30)
  2001. * magit-branch-configure <2>: Branch Commands. (line 31)
  2002. * magit-branch-configure <3>: Branch Commands. (line 32)
  2003. * magit-branch-create: Branch Commands. (line 57)
  2004. * magit-branch-delete: Branch Commands. (line 147)
  2005. * magit-branch-or-checkout: Branch Commands. (line 257)
  2006. * magit-branch-orphan: Branch Commands. (line 252)
  2007. * magit-branch-rename: Branch Commands. (line 153)
  2008. * magit-branch-reset: Branch Commands. (line 131)
  2009. * magit-branch-shelve: Auxiliary Branch Commands.
  2010. (line 9)
  2011. * magit-branch-spinoff: Branch Commands. (line 97)
  2012. * magit-branch-spinout: Branch Commands. (line 125)
  2013. * magit-branch-unshelve: Auxiliary Branch Commands.
  2014. (line 20)
  2015. * magit-checkout: Branch Commands. (line 49)
  2016. * magit-cherry: Cherries. (line 17)
  2017. * magit-cherry-apply: Cherry Picking. (line 24)
  2018. * magit-cherry-copy: Cherry Picking. (line 17)
  2019. * magit-cherry-donate: Cherry Picking. (line 54)
  2020. * magit-cherry-harvest: Cherry Picking. (line 42)
  2021. * magit-cherry-pick: Cherry Picking. (line 8)
  2022. * magit-cherry-spinoff: Cherry Picking. (line 76)
  2023. * magit-cherry-spinout: Cherry Picking. (line 65)
  2024. * magit-clone: Cloning Repository. (line 20)
  2025. * magit-clone-bare: Cloning Repository. (line 41)
  2026. * magit-clone-mirror: Cloning Repository. (line 46)
  2027. * magit-clone-regular: Cloning Repository. (line 29)
  2028. * magit-clone-shallow: Cloning Repository. (line 34)
  2029. * magit-clone-shallow-exclude: Cloning Repository. (line 61)
  2030. * magit-clone-shallow-since: Cloning Repository. (line 54)
  2031. * magit-commit: Initiating a Commit. (line 8)
  2032. * magit-commit <1>: Minor Mode for Buffers Visiting Files.
  2033. (line 68)
  2034. * magit-commit-amend: Initiating a Commit. (line 19)
  2035. * magit-commit-augment: Initiating a Commit. (line 67)
  2036. * magit-commit-create: Initiating a Commit. (line 14)
  2037. * magit-commit-extend: Initiating a Commit. (line 23)
  2038. * magit-commit-fixup: Initiating a Commit. (line 43)
  2039. * magit-commit-instant-fixup: Initiating a Commit. (line 51)
  2040. * magit-commit-instant-squash: Initiating a Commit. (line 63)
  2041. * magit-commit-reword: Initiating a Commit. (line 33)
  2042. * magit-commit-squash: Initiating a Commit. (line 55)
  2043. * magit-copy-buffer-revision: Common Commands. (line 27)
  2044. * magit-copy-section-value: Common Commands. (line 10)
  2045. * magit-cycle-margin-style: Log Margin. (line 60)
  2046. * magit-debug-git-executable: Git Executable. (line 45)
  2047. * magit-debug-git-executable <1>: Debugging Tools. (line 30)
  2048. * magit-describe-section-briefly: Section Types and Values.
  2049. (line 13)
  2050. * magit-describe-section-briefly <1>: Matching Sections. (line 6)
  2051. * magit-diff: Diffing. (line 21)
  2052. * magit-diff <1>: Minor Mode for Buffers Visiting Files.
  2053. (line 75)
  2054. * magit-diff-buffer-file: Minor Mode for Buffers Visiting Files.
  2055. (line 86)
  2056. * magit-diff-default-context: Refreshing Diffs. (line 73)
  2057. * magit-diff-dwim: Diffing. (line 27)
  2058. * magit-diff-edit-hunk-commit: Commands Available in Diffs.
  2059. (line 25)
  2060. * magit-diff-flip-revs: Refreshing Diffs. (line 46)
  2061. * magit-diff-less-context: Refreshing Diffs. (line 65)
  2062. * magit-diff-more-context: Refreshing Diffs. (line 69)
  2063. * magit-diff-paths: Diffing. (line 61)
  2064. * magit-diff-range: Diffing. (line 31)
  2065. * magit-diff-refresh: Refreshing Diffs. (line 11)
  2066. * magit-diff-refresh <1>: Refreshing Diffs. (line 17)
  2067. * magit-diff-save-default-arguments: Refreshing Diffs. (line 29)
  2068. * magit-diff-set-default-arguments: Refreshing Diffs. (line 22)
  2069. * magit-diff-show-or-scroll-down: Log Buffer. (line 45)
  2070. * magit-diff-show-or-scroll-down <1>: Blaming. (line 92)
  2071. * magit-diff-show-or-scroll-up: Log Buffer. (line 35)
  2072. * magit-diff-show-or-scroll-up <1>: Blaming. (line 82)
  2073. * magit-diff-staged: Diffing. (line 51)
  2074. * magit-diff-switch-range-type: Refreshing Diffs. (line 41)
  2075. * magit-diff-toggle-file-filter: Refreshing Diffs. (line 51)
  2076. * magit-diff-toggle-refine-hunk: Refreshing Diffs. (line 37)
  2077. * magit-diff-trace-definition: Commands Available in Diffs.
  2078. (line 14)
  2079. * magit-diff-unstaged: Diffing. (line 57)
  2080. * magit-diff-visit-file: Visiting Files and Blobs from a Diff.
  2081. (line 8)
  2082. * magit-diff-visit-file-other-frame: Visiting Files and Blobs from a Diff.
  2083. (line 74)
  2084. * magit-diff-visit-file-other-window: Visiting Files and Blobs from a Diff.
  2085. (line 73)
  2086. * magit-diff-visit-file-worktree: Visiting Files and Blobs from a Diff.
  2087. (line 51)
  2088. * magit-diff-visit-worktree-file-other-frame: Visiting Files and Blobs from a Diff.
  2089. (line 76)
  2090. * magit-diff-visit-worktree-file-other-window: Visiting Files and Blobs from a Diff.
  2091. (line 75)
  2092. * magit-diff-while-committing: Refreshing Diffs. (line 81)
  2093. * magit-diff-while-committing <1>: Editing Commit Messages.
  2094. (line 57)
  2095. * magit-diff-working-tree: Diffing. (line 45)
  2096. * magit-discard: Applying. (line 40)
  2097. * magit-dispatch: Transient Commands. (line 18)
  2098. * magit-ediff: Ediffing. (line 21)
  2099. * magit-ediff-compare: Ediffing. (line 26)
  2100. * magit-ediff-dwim: Ediffing. (line 9)
  2101. * magit-ediff-resolve: Ediffing. (line 35)
  2102. * magit-ediff-show-commit: Ediffing. (line 65)
  2103. * magit-ediff-show-staged: Ediffing. (line 57)
  2104. * magit-ediff-show-stash: Ediffing. (line 69)
  2105. * magit-ediff-show-unstaged: Ediffing. (line 53)
  2106. * magit-ediff-show-working-tree: Ediffing. (line 61)
  2107. * magit-ediff-stage: Ediffing. (line 48)
  2108. * magit-edit-line-commit: Minor Mode for Buffers Visiting Files.
  2109. (line 136)
  2110. * magit-emacs-Q-command: Debugging Tools. (line 16)
  2111. * magit-fetch: Fetching. (line 9)
  2112. * magit-fetch-all: Fetching. (line 46)
  2113. * magit-fetch-branch: Fetching. (line 36)
  2114. * magit-fetch-from-pushremote: Fetching. (line 15)
  2115. * magit-fetch-from-upstream: Fetching. (line 24)
  2116. * magit-fetch-modules: Submodule Transient. (line 58)
  2117. * magit-fetch-other: Fetching. (line 32)
  2118. * magit-fetch-refspec: Fetching. (line 41)
  2119. * magit-file-checkout: Resetting. (line 44)
  2120. * magit-file-checkout <1>: Minor Mode for Buffers Visiting Files.
  2121. (line 165)
  2122. * magit-file-delete: Minor Mode for Buffers Visiting Files.
  2123. (line 157)
  2124. * magit-file-dispatch: Minor Mode for Buffers Visiting Files.
  2125. (line 54)
  2126. * magit-file-rename: Minor Mode for Buffers Visiting Files.
  2127. (line 153)
  2128. * magit-file-untrack: Minor Mode for Buffers Visiting Files.
  2129. (line 161)
  2130. * magit-find-file: General-Purpose Visit Commands.
  2131. (line 9)
  2132. * magit-find-file-other-frame: General-Purpose Visit Commands.
  2133. (line 21)
  2134. * magit-find-file-other-window: General-Purpose Visit Commands.
  2135. (line 15)
  2136. * magit-git-command: Running Git Manually.
  2137. (line 25)
  2138. * magit-git-command-topdir: Running Git Manually.
  2139. (line 17)
  2140. * magit-go-backward: Log Buffer. (line 21)
  2141. * magit-go-backward <1>: Refreshing Diffs. (line 91)
  2142. * magit-go-forward: Log Buffer. (line 25)
  2143. * magit-go-forward <1>: Refreshing Diffs. (line 95)
  2144. * magit-init: Creating Repository. (line 6)
  2145. * magit-jump-to-diffstat-or-diff: Commands Available in Diffs.
  2146. (line 45)
  2147. * magit-kill-this-buffer: Minor Mode for Buffers Visiting Blobs.
  2148. (line 20)
  2149. * magit-list-repositories: Repository List. (line 6)
  2150. * magit-list-submodules: Listing Submodules. (line 13)
  2151. * magit-list-submodules <1>: Submodule Transient. (line 54)
  2152. * magit-log: Logging. (line 29)
  2153. * magit-log <1>: Minor Mode for Buffers Visiting Files.
  2154. (line 96)
  2155. * magit-log-all: Logging. (line 60)
  2156. * magit-log-all-branches: Logging. (line 56)
  2157. * magit-log-branches: Logging. (line 52)
  2158. * magit-log-buffer-file: Minor Mode for Buffers Visiting Files.
  2159. (line 107)
  2160. * magit-log-bury-buffer: Log Buffer. (line 14)
  2161. * magit-log-current: Logging. (line 35)
  2162. * magit-log-double-commit-limit: Log Buffer. (line 61)
  2163. * magit-log-half-commit-limit: Log Buffer. (line 65)
  2164. * magit-log-head: Logging. (line 48)
  2165. * magit-log-move-to-parent: Log Buffer. (line 29)
  2166. * magit-log-other: Logging. (line 41)
  2167. * magit-log-refresh: Refreshing Logs. (line 11)
  2168. * magit-log-refresh <1>: Refreshing Logs. (line 17)
  2169. * magit-log-refresh <2>: Log Buffer. (line 6)
  2170. * magit-log-save-default-arguments: Refreshing Logs. (line 29)
  2171. * magit-log-select-pick: Select from Log. (line 20)
  2172. * magit-log-select-quit: Select from Log. (line 26)
  2173. * magit-log-set-default-arguments: Refreshing Logs. (line 22)
  2174. * magit-log-toggle-commit-limit: Log Buffer. (line 55)
  2175. * magit-log-trace-definition: Minor Mode for Buffers Visiting Files.
  2176. (line 114)
  2177. * magit-margin-settings: Log Margin. (line 47)
  2178. * magit-merge: Merging. (line 9)
  2179. * magit-merge <1>: Merging. (line 89)
  2180. * magit-merge-abort: Merging. (line 95)
  2181. * magit-merge-absorb: Merging. (line 45)
  2182. * magit-merge-editmsg: Merging. (line 31)
  2183. * magit-merge-into: Merging. (line 58)
  2184. * magit-merge-nocommit: Merging. (line 38)
  2185. * magit-merge-plain: Merging. (line 18)
  2186. * magit-merge-preview: Merging. (line 81)
  2187. * magit-merge-squash: Merging. (line 72)
  2188. * magit-mode-bury-buffer: Quitting Windows. (line 6)
  2189. * magit-notes: Notes. (line 8)
  2190. * magit-notes-edit: Notes. (line 14)
  2191. * magit-notes-merge: Notes. (line 38)
  2192. * magit-notes-merge-abort: Notes. (line 52)
  2193. * magit-notes-merge-commit: Notes. (line 47)
  2194. * magit-notes-prune: Notes. (line 30)
  2195. * magit-notes-remove: Notes. (line 22)
  2196. * magit-patch: Plain Patches. (line 6)
  2197. * magit-patch-apply: Plain Patches. (line 21)
  2198. * magit-patch-apply <1>: Maildir Patches. (line 25)
  2199. * magit-patch-create: Plain Patches. (line 12)
  2200. * magit-patch-save: Plain Patches. (line 28)
  2201. * magit-pop-revision-stack: Editing Commit Messages.
  2202. (line 63)
  2203. * magit-process: Viewing Git Output. (line 16)
  2204. * magit-process-kill: Viewing Git Output. (line 24)
  2205. * magit-pull: Pulling. (line 9)
  2206. * magit-pull-branch: Pulling. (line 31)
  2207. * magit-pull-from-pushremote: Pulling. (line 14)
  2208. * magit-pull-from-upstream: Pulling. (line 23)
  2209. * magit-push: Pushing. (line 9)
  2210. * magit-push-current: Pushing. (line 31)
  2211. * magit-push-current-to-pushremote: Pushing. (line 15)
  2212. * magit-push-current-to-upstream: Pushing. (line 23)
  2213. * magit-push-implicitly args: Pushing. (line 74)
  2214. * magit-push-matching: Pushing. (line 50)
  2215. * magit-push-other: Pushing. (line 36)
  2216. * magit-push-refspecs: Pushing. (line 41)
  2217. * magit-push-tag: Pushing. (line 66)
  2218. * magit-push-tags: Pushing. (line 58)
  2219. * magit-push-to-remote remote args: Pushing. (line 85)
  2220. * magit-rebase: Rebasing. (line 9)
  2221. * magit-rebase-abort: Rebasing. (line 124)
  2222. * magit-rebase-autosquash: Rebasing. (line 85)
  2223. * magit-rebase-branch: Rebasing. (line 45)
  2224. * magit-rebase-continue: Rebasing. (line 107)
  2225. * magit-rebase-edit: Rebasing. (line 119)
  2226. * magit-rebase-edit-commit: Rebasing. (line 90)
  2227. * magit-rebase-interactive: Rebasing. (line 81)
  2228. * magit-rebase-onto-pushremote: Rebasing. (line 28)
  2229. * magit-rebase-onto-upstream: Rebasing. (line 37)
  2230. * magit-rebase-remove-commit: Rebasing. (line 100)
  2231. * magit-rebase-reword-commit: Rebasing. (line 95)
  2232. * magit-rebase-skip: Rebasing. (line 114)
  2233. * magit-rebase-subset: Rebasing. (line 51)
  2234. * magit-reflog-current: Reflog. (line 11)
  2235. * magit-reflog-head: Reflog. (line 19)
  2236. * magit-reflog-other: Reflog. (line 15)
  2237. * magit-refresh: Automatic Refreshing of Magit Buffers.
  2238. (line 24)
  2239. * magit-refresh-all: Automatic Refreshing of Magit Buffers.
  2240. (line 33)
  2241. * magit-remote: Remote Commands. (line 13)
  2242. * magit-remote-add: Remote Commands. (line 50)
  2243. * magit-remote-configure: Remote Commands. (line 33)
  2244. * magit-remote-prune: Remote Commands. (line 69)
  2245. * magit-remote-prune-refspecs: Remote Commands. (line 74)
  2246. * magit-remote-remove: Remote Commands. (line 65)
  2247. * magit-remote-rename: Remote Commands. (line 55)
  2248. * magit-remote-set-url: Remote Commands. (line 60)
  2249. * magit-reset-hard: Resetting. (line 26)
  2250. * magit-reset-index: Staging and Unstaging.
  2251. (line 87)
  2252. * magit-reset-index <1>: Resetting. (line 31)
  2253. * magit-reset-mixed: Resetting. (line 15)
  2254. * magit-reset-quickly: Resetting. (line 8)
  2255. * magit-reset-soft: Resetting. (line 20)
  2256. * magit-reset-worktree: Resetting. (line 38)
  2257. * magit-reset-worktree <1>: Wip Modes. (line 66)
  2258. * magit-reverse: Applying. (line 44)
  2259. * magit-reverse-in-index: Staging and Unstaging.
  2260. (line 62)
  2261. * magit-revert: Reverting. (line 6)
  2262. * magit-revert-and-commit: Reverting. (line 15)
  2263. * magit-revert-no-commit: Reverting. (line 21)
  2264. * magit-run: Running Git Manually.
  2265. (line 12)
  2266. * magit-run-git-gui: Running Git Manually.
  2267. (line 66)
  2268. * magit-run-gitk: Running Git Manually.
  2269. (line 54)
  2270. * magit-run-gitk-all: Running Git Manually.
  2271. (line 58)
  2272. * magit-run-gitk-branches: Running Git Manually.
  2273. (line 62)
  2274. * magit-section-backward: Section Movement. (line 10)
  2275. * magit-section-backward-siblings: Section Movement. (line 20)
  2276. * magit-section-cycle: Section Visibility. (line 13)
  2277. * magit-section-cycle-diffs: Section Visibility. (line 17)
  2278. * magit-section-cycle-global: Section Visibility. (line 22)
  2279. * magit-section-forward: Section Movement. (line 16)
  2280. * magit-section-forward-siblings: Section Movement. (line 26)
  2281. * magit-section-hide: Section Visibility. (line 49)
  2282. * magit-section-hide-children: Section Visibility. (line 64)
  2283. * magit-section-show: Section Visibility. (line 45)
  2284. * magit-section-show-children: Section Visibility. (line 58)
  2285. * magit-section-show-headings: Section Visibility. (line 53)
  2286. * magit-section-show-level-1: Section Visibility. (line 26)
  2287. * magit-section-show-level-1-all: Section Visibility. (line 33)
  2288. * magit-section-show-level-2: Section Visibility. (line 27)
  2289. * magit-section-show-level-2-all: Section Visibility. (line 34)
  2290. * magit-section-show-level-3: Section Visibility. (line 28)
  2291. * magit-section-show-level-3-all: Section Visibility. (line 35)
  2292. * magit-section-show-level-4: Section Visibility. (line 29)
  2293. * magit-section-show-level-4-all: Section Visibility. (line 36)
  2294. * magit-section-toggle: Section Visibility. (line 9)
  2295. * magit-section-toggle-children: Section Visibility. (line 68)
  2296. * magit-section-up: Section Movement. (line 31)
  2297. * magit-sequence-abort: Cherry Picking. (line 98)
  2298. * magit-sequence-abort <1>: Reverting. (line 39)
  2299. * magit-sequence-continue: Cherry Picking. (line 90)
  2300. * magit-sequence-continue <1>: Reverting. (line 31)
  2301. * magit-sequence-skip: Cherry Picking. (line 94)
  2302. * magit-sequence-skip <1>: Reverting. (line 35)
  2303. * magit-shell-command: Running Git Manually.
  2304. (line 40)
  2305. * magit-shell-command-topdir: Running Git Manually.
  2306. (line 35)
  2307. * magit-show-commit: Diffing. (line 69)
  2308. * magit-show-commit <1>: Blaming. (line 78)
  2309. * magit-show-refs: References Buffer. (line 6)
  2310. * magit-show-refs-current: References Buffer. (line 26)
  2311. * magit-show-refs-head: References Buffer. (line 21)
  2312. * magit-show-refs-other: References Buffer. (line 32)
  2313. * magit-snapshot-both: Stashing. (line 40)
  2314. * magit-snapshot-index: Stashing. (line 47)
  2315. * magit-snapshot-worktree: Stashing. (line 52)
  2316. * magit-stage: Staging and Unstaging.
  2317. (line 28)
  2318. * magit-stage-file: Staging from File-Visiting Buffers.
  2319. (line 10)
  2320. * magit-stage-file <1>: Minor Mode for Buffers Visiting Files.
  2321. (line 59)
  2322. * magit-stage-modified: Staging and Unstaging.
  2323. (line 36)
  2324. * magit-stash: Stashing. (line 8)
  2325. * magit-stash-apply: Stashing. (line 59)
  2326. * magit-stash-both: Stashing. (line 14)
  2327. * magit-stash-branch: Stashing. (line 81)
  2328. * magit-stash-branch-here: Stashing. (line 86)
  2329. * magit-stash-clear: Stashing. (line 96)
  2330. * magit-stash-drop: Stashing. (line 72)
  2331. * magit-stash-format-patch: Stashing. (line 92)
  2332. * magit-stash-index: Stashing. (line 21)
  2333. * magit-stash-keep-index: Stashing. (line 33)
  2334. * magit-stash-list: Stashing. (line 100)
  2335. * magit-stash-pop: Stashing. (line 65)
  2336. * magit-stash-show: Diffing. (line 74)
  2337. * magit-stash-show <1>: Stashing. (line 77)
  2338. * magit-stash-worktree: Stashing. (line 26)
  2339. * magit-status: Status Buffer. (line 22)
  2340. * magit-submodule: Submodule Transient. (line 6)
  2341. * magit-submodule-add: Submodule Transient. (line 20)
  2342. * magit-submodule-fetch: Fetching. (line 50)
  2343. * magit-submodule-populate: Submodule Transient. (line 34)
  2344. * magit-submodule-register: Submodule Transient. (line 27)
  2345. * magit-submodule-synchronize: Submodule Transient. (line 44)
  2346. * magit-submodule-unpopulate: Submodule Transient. (line 50)
  2347. * magit-submodule-update: Submodule Transient. (line 39)
  2348. * magit-subtree: Subtree. (line 8)
  2349. * magit-subtree-add: Subtree. (line 25)
  2350. * magit-subtree-add-commit: Subtree. (line 30)
  2351. * magit-subtree-export: Subtree. (line 42)
  2352. * magit-subtree-import: Subtree. (line 13)
  2353. * magit-subtree-merge: Subtree. (line 34)
  2354. * magit-subtree-pull: Subtree. (line 38)
  2355. * magit-subtree-push: Subtree. (line 54)
  2356. * magit-subtree-split: Subtree. (line 59)
  2357. * magit-tag: Tagging. (line 8)
  2358. * magit-tag-create: Tagging. (line 14)
  2359. * magit-tag-delete: Tagging. (line 40)
  2360. * magit-tag-prune: Tagging. (line 47)
  2361. * magit-tag-release: Tagging. (line 19)
  2362. * magit-toggle-buffer-lock: Modes and Buffers. (line 17)
  2363. * magit-toggle-margin: Refreshing Logs. (line 37)
  2364. * magit-toggle-margin <1>: Log Margin. (line 56)
  2365. * magit-toggle-margin-details: Log Margin. (line 64)
  2366. * magit-unstage: Staging and Unstaging.
  2367. (line 43)
  2368. * magit-unstage-all: Staging and Unstaging.
  2369. (line 52)
  2370. * magit-unstage-file: Staging from File-Visiting Buffers.
  2371. (line 18)
  2372. * magit-unstage-file <1>: Minor Mode for Buffers Visiting Files.
  2373. (line 63)
  2374. * magit-version: Git Executable. (line 17)
  2375. * magit-version <1>: Debugging Tools. (line 10)
  2376. * magit-visit-ref: References Buffer. (line 179)
  2377. * magit-wip-commit: Wip Modes. (line 88)
  2378. * magit-wip-log: Wip Modes. (line 48)
  2379. * magit-wip-log-current: Wip Modes. (line 57)
  2380. * magit-worktree: Worktree. (line 8)
  2381. * magit-worktree-branch: Worktree. (line 17)
  2382. * magit-worktree-checkout: Worktree. (line 13)
  2383. * magit-worktree-delete: Worktree. (line 21)
  2384. * magit-worktree-status: Worktree. (line 26)
  2385. * scroll-down: Commands Available in Diffs.
  2386. (line 60)
  2387. * scroll-up: Commands Available in Diffs.
  2388. (line 56)
  2389. * with-editor-cancel: Editing Commit Messages.
  2390. (line 24)
  2391. * with-editor-cancel <1>: Editing Rebase Sequences.
  2392. (line 11)
  2393. * with-editor-debug: Debugging Tools. (line 38)
  2394. * with-editor-finish: Editing Commit Messages.
  2395. (line 19)
  2396. * with-editor-finish <1>: Editing Rebase Sequences.
  2397. (line 6)
  2398. 
  2399. File: magit.info, Node: Function Index, Next: Variable Index, Prev: Command Index, Up: Top
  2400. Appendix E Function Index
  2401. *************************
  2402. [index]
  2403. * Menu:
  2404. * git-commit-check-style-conventions: Editing Commit Messages.
  2405. (line 247)
  2406. * git-commit-propertize-diff: Editing Commit Messages.
  2407. (line 206)
  2408. * git-commit-save-message: Editing Commit Messages.
  2409. (line 187)
  2410. * git-commit-setup-changelog-support: Editing Commit Messages.
  2411. (line 191)
  2412. * git-commit-turn-on-auto-fill: Editing Commit Messages.
  2413. (line 196)
  2414. * git-commit-turn-on-flyspell: Editing Commit Messages.
  2415. (line 201)
  2416. * ido-enter-magit-status: Status Buffer. (line 72)
  2417. * magit-add-section-hook: Section Hooks. (line 20)
  2418. * magit-after-save-refresh-status: Automatic Refreshing of Magit Buffers.
  2419. (line 58)
  2420. * magit-branch-or-checkout: Branch Commands. (line 257)
  2421. * magit-branch-orphan: Branch Commands. (line 252)
  2422. * magit-branch-shelve: Auxiliary Branch Commands.
  2423. (line 9)
  2424. * magit-branch-unshelve: Auxiliary Branch Commands.
  2425. (line 20)
  2426. * magit-builtin-completing-read: Support for Completion Frameworks.
  2427. (line 42)
  2428. * magit-call-git: Calling Git for Effect.
  2429. (line 28)
  2430. * magit-call-process: Calling Git for Effect.
  2431. (line 32)
  2432. * magit-cancel-section: Creating Sections. (line 71)
  2433. * magit-completing-read: Support for Completion Frameworks.
  2434. (line 60)
  2435. * magit-current-section: Section Selection. (line 6)
  2436. * magit-define-section-jumper: Creating Sections. (line 77)
  2437. * magit-diff-scope: Matching Sections. (line 118)
  2438. * magit-diff-type: Matching Sections. (line 95)
  2439. * magit-diff-visit-file-other-frame: Visiting Files and Blobs from a Diff.
  2440. (line 74)
  2441. * magit-diff-visit-file-other-window: Visiting Files and Blobs from a Diff.
  2442. (line 73)
  2443. * magit-diff-visit-worktree-file-other-frame: Visiting Files and Blobs from a Diff.
  2444. (line 76)
  2445. * magit-diff-visit-worktree-file-other-window: Visiting Files and Blobs from a Diff.
  2446. (line 75)
  2447. * magit-display-buffer: Switching Buffers. (line 6)
  2448. * magit-display-buffer-fullcolumn-most-v1: Switching Buffers. (line 76)
  2449. * magit-display-buffer-fullframe-status-topleft-v1: Switching Buffers.
  2450. (line 66)
  2451. * magit-display-buffer-fullframe-status-v1: Switching Buffers.
  2452. (line 60)
  2453. * magit-display-buffer-same-window-except-diff-v1: Switching Buffers.
  2454. (line 54)
  2455. * magit-display-buffer-traditional: Switching Buffers. (line 46)
  2456. * magit-file-checkout: Minor Mode for Buffers Visiting Files.
  2457. (line 165)
  2458. * magit-file-delete: Minor Mode for Buffers Visiting Files.
  2459. (line 157)
  2460. * magit-file-rename: Minor Mode for Buffers Visiting Files.
  2461. (line 153)
  2462. * magit-file-untrack: Minor Mode for Buffers Visiting Files.
  2463. (line 161)
  2464. * magit-find-file: General-Purpose Visit Commands.
  2465. (line 9)
  2466. * magit-find-file-other-frame: General-Purpose Visit Commands.
  2467. (line 21)
  2468. * magit-find-file-other-window: General-Purpose Visit Commands.
  2469. (line 15)
  2470. * magit-generate-buffer-name-default-function: Naming Buffers.
  2471. (line 17)
  2472. * magit-get-section: Matching Sections. (line 16)
  2473. * magit-git: Calling Git for Effect.
  2474. (line 65)
  2475. * magit-git-exit-code: Getting a Value from Git.
  2476. (line 10)
  2477. * magit-git-failure: Getting a Value from Git.
  2478. (line 19)
  2479. * magit-git-false: Getting a Value from Git.
  2480. (line 29)
  2481. * magit-git-insert: Getting a Value from Git.
  2482. (line 34)
  2483. * magit-git-items: Getting a Value from Git.
  2484. (line 49)
  2485. * magit-git-lines: Getting a Value from Git.
  2486. (line 44)
  2487. * magit-git-str: Getting a Value from Git.
  2488. (line 72)
  2489. * magit-git-string: Getting a Value from Git.
  2490. (line 38)
  2491. * magit-git-success: Getting a Value from Git.
  2492. (line 14)
  2493. * magit-git-true: Getting a Value from Git.
  2494. (line 24)
  2495. * magit-git-wash: Calling Git for Effect.
  2496. (line 70)
  2497. * magit-hunk-set-window-start: Section Movement. (line 43)
  2498. * magit-ido-completing-read: Support for Completion Frameworks.
  2499. (line 48)
  2500. * magit-insert-am-sequence: Status Sections. (line 28)
  2501. * magit-insert-assumed-unchanged-files: Status Sections. (line 117)
  2502. * magit-insert-bisect-log: Status Sections. (line 46)
  2503. * magit-insert-bisect-output: Status Sections. (line 38)
  2504. * magit-insert-bisect-rest: Status Sections. (line 42)
  2505. * magit-insert-diff-filter-header: Status Header Sections.
  2506. (line 38)
  2507. * magit-insert-error-header: Status Header Sections.
  2508. (line 28)
  2509. * magit-insert-head-branch-header: Status Header Sections.
  2510. (line 42)
  2511. * magit-insert-heading: Creating Sections. (line 42)
  2512. * magit-insert-ignored-files: Status Sections. (line 100)
  2513. * magit-insert-local-branches: References Sections. (line 17)
  2514. * magit-insert-merge-log: Status Sections. (line 18)
  2515. * magit-insert-modules: Status Module Sections.
  2516. (line 12)
  2517. * magit-insert-modules-overview: Status Module Sections.
  2518. (line 33)
  2519. * magit-insert-modules-unpulled-from-pushremote: Status Module Sections.
  2520. (line 50)
  2521. * magit-insert-modules-unpulled-from-upstream: Status Module Sections.
  2522. (line 44)
  2523. * magit-insert-modules-unpushed-to-pushremote: Status Module Sections.
  2524. (line 62)
  2525. * magit-insert-modules-unpushed-to-upstream: Status Module Sections.
  2526. (line 56)
  2527. * magit-insert-push-branch-header: Status Header Sections.
  2528. (line 51)
  2529. * magit-insert-rebase-sequence: Status Sections. (line 23)
  2530. * magit-insert-recent-commits: Status Sections. (line 131)
  2531. * magit-insert-remote-branches: References Sections. (line 21)
  2532. * magit-insert-remote-header: Status Header Sections.
  2533. (line 67)
  2534. * magit-insert-repo-header: Status Header Sections.
  2535. (line 63)
  2536. * magit-insert-section: Creating Sections. (line 6)
  2537. * magit-insert-sequencer-sequence: Status Sections. (line 33)
  2538. * magit-insert-skip-worktree-files: Status Sections. (line 110)
  2539. * magit-insert-staged-changes: Status Sections. (line 63)
  2540. * magit-insert-stashes: Status Sections. (line 67)
  2541. * magit-insert-status-headers: Status Header Sections.
  2542. (line 12)
  2543. * magit-insert-submodules: Listing Submodules. (line 35)
  2544. * magit-insert-tags: References Sections. (line 25)
  2545. * magit-insert-tags-header: Status Header Sections.
  2546. (line 56)
  2547. * magit-insert-tracked-files: Status Sections. (line 96)
  2548. * magit-insert-unpulled-cherries: Status Sections. (line 142)
  2549. * magit-insert-unpulled-from-pushremote: Status Sections. (line 79)
  2550. * magit-insert-unpulled-from-upstream: Status Sections. (line 74)
  2551. * magit-insert-unpulled-or-recent-commits: Status Sections. (line 124)
  2552. * magit-insert-unpushed-cherries: Status Sections. (line 149)
  2553. * magit-insert-unpushed-to-pushremote: Status Sections. (line 89)
  2554. * magit-insert-unpushed-to-upstream: Status Sections. (line 84)
  2555. * magit-insert-unstaged-changes: Status Sections. (line 59)
  2556. * magit-insert-untracked-files: Status Sections. (line 50)
  2557. * magit-insert-upstream-branch-header: Status Header Sections.
  2558. (line 46)
  2559. * magit-insert-user-header: Status Header Sections.
  2560. (line 75)
  2561. * magit-list-repositories: Repository List. (line 6)
  2562. * magit-list-submodules: Listing Submodules. (line 13)
  2563. * magit-log-maybe-show-more-commits: Section Movement. (line 57)
  2564. * magit-log-maybe-update-blob-buffer: Section Movement. (line 71)
  2565. * magit-log-maybe-update-revision-buffer: Section Movement. (line 64)
  2566. * magit-maybe-set-dedicated: Switching Buffers. (line 101)
  2567. * magit-mode-display-buffer: Refreshing Buffers. (line 33)
  2568. * magit-mode-quit-window: Quitting Windows. (line 34)
  2569. * magit-mode-setup: Refreshing Buffers. (line 17)
  2570. * magit-push-implicitly: Pushing. (line 74)
  2571. * magit-push-to-remote: Pushing. (line 85)
  2572. * magit-region-sections: Section Selection. (line 10)
  2573. * magit-region-values: Section Selection. (line 37)
  2574. * magit-repolist-column-ident: Repository List. (line 30)
  2575. * magit-repolist-column-path: Repository List. (line 35)
  2576. * magit-repolist-column-unpulled-from-pushremote: Repository List.
  2577. (line 49)
  2578. * magit-repolist-column-unpulled-from-upstream: Repository List.
  2579. (line 44)
  2580. * magit-repolist-column-unpushed-to-pushremote: Repository List.
  2581. (line 59)
  2582. * magit-repolist-column-unpushed-to-upstream: Repository List.
  2583. (line 54)
  2584. * magit-repolist-column-version: Repository List. (line 39)
  2585. * magit-restore-window-configuration: Quitting Windows. (line 23)
  2586. * magit-revert-buffers: Editing Commit Messages.
  2587. (line 178)
  2588. * magit-run-git: Calling Git for Effect.
  2589. (line 36)
  2590. * magit-run-git-async: Calling Git for Effect.
  2591. (line 80)
  2592. * magit-run-git-with-editor: Calling Git for Effect.
  2593. (line 93)
  2594. * magit-run-git-with-input: Calling Git for Effect.
  2595. (line 40)
  2596. * magit-run-git-with-logfile: Calling Git for Effect.
  2597. (line 56)
  2598. * magit-save-window-configuration: Switching Buffers. (line 90)
  2599. * magit-section-case: Matching Sections. (line 71)
  2600. * magit-section-hide: Section Visibility. (line 49)
  2601. * magit-section-hide-children: Section Visibility. (line 64)
  2602. * magit-section-ident: Matching Sections. (line 11)
  2603. * magit-section-match: Matching Sections. (line 21)
  2604. * magit-section-set-window-start: Section Movement. (line 50)
  2605. * magit-section-show: Section Visibility. (line 45)
  2606. * magit-section-show-children: Section Visibility. (line 58)
  2607. * magit-section-show-headings: Section Visibility. (line 53)
  2608. * magit-section-toggle-children: Section Visibility. (line 68)
  2609. * magit-section-value-if: Matching Sections. (line 61)
  2610. * magit-start-git: Calling Git for Effect.
  2611. (line 105)
  2612. * magit-start-process: Calling Git for Effect.
  2613. (line 124)
  2614. * magit-status-maybe-update-blob-buffer: Section Movement. (line 83)
  2615. * magit-status-maybe-update-revision-buffer: Section Movement.
  2616. (line 77)
  2617. * magit-wip-log: Wip Modes. (line 48)
  2618. * magit-wip-log-current: Wip Modes. (line 57)
  2619. * with-editor-usage-message: Editing Commit Messages.
  2620. (line 215)
  2621. 
  2622. File: magit.info, Node: Variable Index, Prev: Function Index, Up: Top
  2623. Appendix F Variable Index
  2624. *************************
  2625. [index]
  2626. * Menu:
  2627. * auto-revert-buffer-list-filter: Automatic Reverting of File-Visiting Buffers.
  2628. (line 81)
  2629. * auto-revert-interval: Automatic Reverting of File-Visiting Buffers.
  2630. (line 76)
  2631. * auto-revert-mode: Automatic Reverting of File-Visiting Buffers.
  2632. (line 62)
  2633. * auto-revert-stop-on-user-input: Automatic Reverting of File-Visiting Buffers.
  2634. (line 71)
  2635. * auto-revert-use-notify: Automatic Reverting of File-Visiting Buffers.
  2636. (line 49)
  2637. * auto-revert-verbose: Automatic Reverting of File-Visiting Buffers.
  2638. (line 103)
  2639. * branch.autoSetupMerge: Branch Git Variables.
  2640. (line 81)
  2641. * branch.autoSetupRebase: Branch Git Variables.
  2642. (line 98)
  2643. * branch.NAME.description: Branch Git Variables.
  2644. (line 48)
  2645. * branch.NAME.merge: Branch Git Variables.
  2646. (line 10)
  2647. * branch.NAME.pushRemote: Branch Git Variables.
  2648. (line 34)
  2649. * branch.NAME.rebase: Branch Git Variables.
  2650. (line 22)
  2651. * branch.NAME.remote: Branch Git Variables.
  2652. (line 16)
  2653. * core.notesRef: Notes. (line 60)
  2654. * git-commit-fill-column: Editing Commit Messages.
  2655. (line 228)
  2656. * git-commit-finish-query-functions: Editing Commit Messages.
  2657. (line 233)
  2658. * git-commit-known-pseudo-headers: Editing Commit Messages.
  2659. (line 124)
  2660. * git-commit-major-mode: Editing Commit Messages.
  2661. (line 163)
  2662. * git-commit-setup-hook: Editing Commit Messages.
  2663. (line 174)
  2664. * git-commit-summary-max-length: Editing Commit Messages.
  2665. (line 222)
  2666. * git-rebase-auto-advance: Editing Rebase Sequences.
  2667. (line 99)
  2668. * git-rebase-confirm-cancel: Editing Rebase Sequences.
  2669. (line 107)
  2670. * git-rebase-show-instructions: Editing Rebase Sequences.
  2671. (line 103)
  2672. * global-auto-revert-mode: Automatic Reverting of File-Visiting Buffers.
  2673. (line 22)
  2674. * global-magit-file-mode: Minor Mode for Buffers Visiting Files.
  2675. (line 13)
  2676. * magit-auto-revert-immediately: Automatic Reverting of File-Visiting Buffers.
  2677. (line 32)
  2678. * magit-auto-revert-mode: Automatic Reverting of File-Visiting Buffers.
  2679. (line 17)
  2680. * magit-auto-revert-tracked-only: Automatic Reverting of File-Visiting Buffers.
  2681. (line 55)
  2682. * magit-bisect-show-graph: Bisecting. (line 55)
  2683. * magit-blame-disable-modes: Blaming. (line 168)
  2684. * magit-blame-echo-style: Blaming. (line 151)
  2685. * magit-blame-goto-chunk-hook: Blaming. (line 174)
  2686. * magit-blame-read-only: Blaming. (line 163)
  2687. * magit-blame-styles: Blaming. (line 146)
  2688. * magit-blame-time-format: Blaming. (line 158)
  2689. * magit-branch-adjust-remote-upstream-alist: Branch Commands. (line 210)
  2690. * magit-branch-direct-configure: Branch Commands. (line 20)
  2691. * magit-branch-prefer-remote-upstream: Branch Commands. (line 165)
  2692. * magit-branch-read-upstream-first: Branch Commands. (line 159)
  2693. * magit-buffer-name-format: Naming Buffers. (line 27)
  2694. * magit-bury-buffer-function: Quitting Windows. (line 14)
  2695. * magit-cherry-margin: Cherries. (line 22)
  2696. * magit-clone-always-transient: Cloning Repository. (line 12)
  2697. * magit-clone-default-directory: Cloning Repository. (line 90)
  2698. * magit-clone-name-alist: Cloning Repository. (line 103)
  2699. * magit-clone-set-remote-head: Cloning Repository. (line 68)
  2700. * magit-clone-set-remote.pushDefault: Cloning Repository. (line 78)
  2701. * magit-clone-url-format: Cloning Repository. (line 124)
  2702. * magit-commit-ask-to-stage: Initiating a Commit. (line 75)
  2703. * magit-commit-extend-override-date: Initiating a Commit. (line 80)
  2704. * magit-commit-reword-override-date: Initiating a Commit. (line 84)
  2705. * magit-commit-squash-confirm: Initiating a Commit. (line 88)
  2706. * magit-completing-read-function: Support for Completion Frameworks.
  2707. (line 27)
  2708. * magit-diff-adjust-tab-width: Diff Options. (line 21)
  2709. * magit-diff-buffer-file-locked: Minor Mode for Buffers Visiting Files.
  2710. (line 91)
  2711. * magit-diff-hide-trailing-cr-characters: Diff Options. (line 90)
  2712. * magit-diff-highlight-hunk-region-functions: Diff Options. (line 94)
  2713. * magit-diff-highlight-indentation: Diff Options. (line 75)
  2714. * magit-diff-highlight-trailing: Diff Options. (line 70)
  2715. * magit-diff-paint-whitespace: Diff Options. (line 43)
  2716. * magit-diff-paint-whitespace-lines: Diff Options. (line 60)
  2717. * magit-diff-refine-hunk: Diff Options. (line 6)
  2718. * magit-diff-refine-ignore-whitespace: Diff Options. (line 16)
  2719. * magit-diff-unmarked-lines-keep-foreground: Diff Options. (line 120)
  2720. * magit-diff-visit-previous-blob: Visiting Files and Blobs from a Diff.
  2721. (line 39)
  2722. * magit-direct-use-buffer-arguments: Transient Arguments and Buffer Variables.
  2723. (line 73)
  2724. * magit-display-buffer-function: Switching Buffers. (line 27)
  2725. * magit-display-buffer-noselect: Switching Buffers. (line 18)
  2726. * magit-dwim-selection: Completion and Confirmation.
  2727. (line 42)
  2728. * magit-ediff-dwim-show-on-hunks: Ediffing. (line 73)
  2729. * magit-ediff-quit-hook: Ediffing. (line 88)
  2730. * magit-ediff-show-stash-with-index: Ediffing. (line 81)
  2731. * magit-file-mode-map: Minor Mode for Buffers Visiting Files.
  2732. (line 20)
  2733. * magit-generate-buffer-name-function: Naming Buffers. (line 6)
  2734. * magit-git-debug: Viewing Git Output. (line 28)
  2735. * magit-git-debug <1>: Getting a Value from Git.
  2736. (line 64)
  2737. * magit-git-executable: Git Executable. (line 39)
  2738. * magit-git-global-arguments: Global Git Arguments.
  2739. (line 6)
  2740. * magit-keep-region-overlay: The Selection. (line 52)
  2741. * magit-list-refs-sortby: Additional Completion Options.
  2742. (line 6)
  2743. * magit-log-auto-more: Log Buffer. (line 69)
  2744. * magit-log-buffer-file-locked: Minor Mode for Buffers Visiting Files.
  2745. (line 118)
  2746. * magit-log-margin: Log Margin. (line 12)
  2747. * magit-log-section-args: Status Options. (line 36)
  2748. * magit-log-section-commit-count: Status Sections. (line 136)
  2749. * magit-log-select-margin: Select from Log. (line 30)
  2750. * magit-log-show-refname-after-summary: Log Buffer. (line 75)
  2751. * magit-log-trace-definition-function: Commands Available in Diffs.
  2752. (line 18)
  2753. * magit-module-sections-hook: Status Module Sections.
  2754. (line 20)
  2755. * magit-module-sections-nested: Status Module Sections.
  2756. (line 24)
  2757. * magit-no-confirm: Action Confirmation. (line 18)
  2758. * magit-pop-revision-stack-format: Editing Commit Messages.
  2759. (line 92)
  2760. * magit-post-display-buffer-hook: Switching Buffers. (line 96)
  2761. * magit-pre-display-buffer-hook: Switching Buffers. (line 85)
  2762. * magit-prefer-remote-upstream: Branch Git Variables.
  2763. (line 126)
  2764. * magit-prefix-use-buffer-arguments: Transient Arguments and Buffer Variables.
  2765. (line 64)
  2766. * magit-process-raise-error: Calling Git for Effect.
  2767. (line 151)
  2768. * magit-pull-or-fetch: Fetching. (line 55)
  2769. * magit-reflog-margin: Reflog. (line 23)
  2770. * magit-refresh-args: Refreshing Buffers. (line 55)
  2771. * magit-refresh-buffer-hook: Automatic Refreshing of Magit Buffers.
  2772. (line 42)
  2773. * magit-refresh-function: Refreshing Buffers. (line 49)
  2774. * magit-refresh-status-buffer: Automatic Refreshing of Magit Buffers.
  2775. (line 48)
  2776. * magit-refs-filter-alist: References Buffer. (line 157)
  2777. * magit-refs-focus-column-width: References Buffer. (line 82)
  2778. * magit-refs-margin: References Buffer. (line 97)
  2779. * magit-refs-margin-for-tags: References Buffer. (line 123)
  2780. * magit-refs-pad-commit-counts: References Buffer. (line 49)
  2781. * magit-refs-primary-column-width: References Buffer. (line 69)
  2782. * magit-refs-sections-hook: References Sections. (line 13)
  2783. * magit-refs-show-commit-count: References Buffer. (line 37)
  2784. * magit-refs-show-remote-prefix: References Buffer. (line 62)
  2785. * magit-remote-add-set-remote.pushDefault: Remote Commands. (line 92)
  2786. * magit-remote-direct-configure: Remote Commands. (line 21)
  2787. * magit-remote-set-if-missing: Remote Git Variables.
  2788. (line 39)
  2789. * magit-repolist-columns: Repository List. (line 14)
  2790. * magit-repository-directories: Status Buffer. (line 58)
  2791. * magit-revision-filter-files-on-follow: Revision Buffer. (line 64)
  2792. * magit-revision-insert-related-refs: Revision Buffer. (line 6)
  2793. * magit-revision-show-gravatars: Revision Buffer. (line 19)
  2794. * magit-revision-use-hash-sections: Revision Buffer. (line 36)
  2795. * magit-root-section: Matching Sections. (line 87)
  2796. * magit-save-repository-buffers: Automatic Saving of File-Visiting Buffers.
  2797. (line 13)
  2798. * magit-section-cache-visibility: Section Visibility. (line 95)
  2799. * magit-section-initial-visibility-alist: Section Visibility. (line 78)
  2800. * magit-section-movement-hook: Section Movement. (line 38)
  2801. * magit-section-set-visibility-hook: Section Visibility. (line 106)
  2802. * magit-section-show-child-count: Section Options. (line 9)
  2803. * magit-section-visibility-indicator: Section Visibility. (line 124)
  2804. * magit-shell-command-verbose-prompt: Running Git Manually.
  2805. (line 47)
  2806. * magit-stashes-margin: Stashing. (line 104)
  2807. * magit-status-headers-hook: Status Header Sections.
  2808. (line 18)
  2809. * magit-status-margin: Status Options. (line 10)
  2810. * magit-status-refresh-hook: Status Options. (line 6)
  2811. * magit-status-sections-hook: Status Sections. (line 10)
  2812. * magit-submodule-list-columns: Listing Submodules. (line 21)
  2813. * magit-this-process: Calling Git for Effect.
  2814. (line 146)
  2815. * magit-uniquify-buffer-names: Naming Buffers. (line 74)
  2816. * magit-unstage-committed: Staging and Unstaging.
  2817. (line 56)
  2818. * magit-update-other-window-delay: Section Movement. (line 89)
  2819. * magit-visit-ref-behavior: References Buffer. (line 190)
  2820. * magit-wip-after-apply-mode: Legacy Wip Modes. (line 19)
  2821. * magit-wip-after-apply-mode-lighter: Legacy Wip Modes. (line 59)
  2822. * magit-wip-after-save-local-mode-lighter: Legacy Wip Modes. (line 55)
  2823. * magit-wip-after-save-mode: Legacy Wip Modes. (line 13)
  2824. * magit-wip-before-change-mode: Legacy Wip Modes. (line 33)
  2825. * magit-wip-before-change-mode-lighter: Legacy Wip Modes. (line 63)
  2826. * magit-wip-initial-backup-mode: Legacy Wip Modes. (line 38)
  2827. * magit-wip-initial-backup-mode-lighter: Legacy Wip Modes. (line 67)
  2828. * magit-wip-merge-branch: Wip Graph. (line 6)
  2829. * magit-wip-mode: Wip Modes. (line 30)
  2830. * magit-wip-mode-lighter: Wip Modes. (line 104)
  2831. * magit-wip-namespace: Wip Modes. (line 96)
  2832. * notes.displayRef: Notes. (line 65)
  2833. * pull.rebase: Branch Git Variables.
  2834. (line 57)
  2835. * remote.NAME.fetch: Remote Git Variables.
  2836. (line 15)
  2837. * remote.NAME.push: Remote Git Variables.
  2838. (line 26)
  2839. * remote.NAME.pushurl: Remote Git Variables.
  2840. (line 20)
  2841. * remote.NAME.tagOpts: Remote Git Variables.
  2842. (line 31)
  2843. * remote.NAME.url: Remote Git Variables.
  2844. (line 10)
  2845. * remote.pushDefault: Branch Git Variables.
  2846. (line 71)