README.org

tools/magit

Table of Contents

• Description
  • Maintainers
  • Module Flags
  • Plugins
  • Hacks
• Prerequisites
• Features
• Configuration
  • Enable Gravatars
  • Enable granular diff-highlights for all hunks
• Troubleshooting

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

• magit
• forge* (+forge)
• magit-gitflow
• magit-todos
• github-review
• evil-magit* (:editor evil +everywhere)

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.

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))

Troubleshooting