doomemacs/modules/tools/magit
Björn Larsson 1a0fd1b7ec fix(magit): unbind M-1 etc. for code-review
code-review is built on magit-sections so it will have the same default
bindings for M-1, M-2 etc. To be consistent with the rest of doom, those
should be used for switching workspace and z1, z2 etc should be used for
toggling outlines in a magit-sections buffer.

This only affects users with :editor (evil +everywhere) enabled.

Amend: 2d3a68df49
2022-01-03 18:10:17 +01:00
..
autoload.el feat(magit): replace github-review for code-review 2021-12-15 07:06:49 +00:00
config.el fix(magit): unbind M-1 etc. for code-review 2022-01-03 18:10:17 +01:00
packages.el bump: :tools magit 2022-01-03 16:51:51 +01:00
README.org tools/magit: add magit-diff-refine-hunk to readme 2020-10-18 16:38:07 +02:00

tools/magit

Description

This module provides Magit, an interface to the Git version control system.

If you are new to Magit, see the Getting Started section of its project readme.

Maintainers

This module has no dedicated maintainers.

Module Flags

  • +forge Enable Forge; a porcelain for managing issues and PRs from within Emacs. Will take a while on first run to build emacsql-sqlite.

Plugins

Hacks

  • forge was modified to defer compilation of emacsql-sqlite until you try to use forge, rather than when magit first loads (which could be as soon as startup).
  • magit has been modified to recognize $XDG_CACHE_HOME/git/credential/socket.
  • magit has been modified to invalidate the projectile cache when you check out a new branch or commit.
  • magit has been modified to revert repo buffers (e.g. after changing branches) when you later switch to them, rather than all at once.

Prerequisites

This module requires git.

Forge will require a Github API token the first time you run forge-pull.

TODO Features

Configuration

Add these to $DOOMDIR/config.el.

Enable Gravatars

This will enable gravatars when viewing commits. The service used by default is Libravatar.

(setq magit-revision-show-gravatars '("^Author:     " . "^Commit:     "))

Enable granular diff-highlights for all hunks

By default, changes are highlighted linewise for all but the selected hunk. This has performance reasons. You can enable character-wise highlights for all visible hunks with:

(after! magit
  (setq magit-diff-refine-hunk 'all))

TODO Troubleshooting