History

Henrik Lissner ad6a3d0f33 refactor: deprecate featurep! for modulep! featurep! will be renamed modulep! in the future, so it's been deprecated. They have identical interfaces, and can be replaced without issue. featurep! was never quite the right name for this macro. It implied that it had some connection to featurep, which it doesn't (only that it was similar in purpose; still, Doom modules are not features). To undo such implications and be consistent with its namespace (and since we're heading into a storm of breaking changes with the v3 release anyway), now was the best opportunity to begin the transition.		2022-08-14 20:43:35 +02:00
..
autoload.el	fix(magit): only revert if buffer file exists	2022-06-18 17:19:23 +02:00
config.el	refactor: deprecate featurep! for modulep!	2022-08-14 20:43:35 +02:00
packages.el	refactor: deprecate featurep! for modulep!	2022-08-14 20:43:35 +02:00
README.org	revert: fix(docs): set mode in file-local vars	2022-08-07 19:08:07 +02:00

README.org

:tools magit

Description
- Maintainers
- Module flags
- Packages
- Hacks
- Changelog
Installation
Usage
Configuration
- Enable Gravatars
- Enable granular diff-highlights for all hunks
Troubleshooting
Frequently asked questions
- "I recently updated and now I get 'deferred error : (wrong-type-argument sequencep code-review–auth-token-set\?)' whenever I try to review'"
Appendix

Description unfold

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

Maintainers

@hlissner

Become a maintainer?

Module flags

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

Packages

Hacks

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

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module requires:

Git
+forge requires a Github API token
code-review will also require a token setup (see configuration for your particular forge)

TODO Usage

🔨 This module's usage documentation is incomplete. Complete it?

Start magit with <leader> g g (M-x magit-status).

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

TODO Configuration

🔨 This module's configuration documentation is incomplete. Complete it?

Enable Gravatars

To enable gravatars when viewing commits:

;; in $DOOMDIR/config.el
(after! magit
  (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 is so for performance reasons. You can enable character-wise highlights for all visible hunks with:

;; in $DOOMDIR/config.el
(after! magit
  (setq magit-diff-refine-hunk 'all))

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

"I recently updated and now I get 'deferred error : (wrong-type-argument sequencep code-review–auth-token-set\?)' whenever I try to review'"

The previous package "github-review" was replaced with a package that supercedes it called "code-review", which requires a simple change in your authinfo file.

machine api.github.com login yourlogin^github-review password MYTOKENGOESHERE

becomes

machine api.github.com login yourlogin^code-review password MYTOKENGOESHERE

TODO Appendix

🔨 This module has no appendix yet. Write one?

README.org Unescape Escape