This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+source-control/version-control
2016-11-05 13:03:23 +02:00
..
config.el Rename and add missing definition of version-control-diff-side 2016-11-05 13:03:23 +02:00
funcs.el version-control: change function prefix to spacemacs 2016-07-06 21:12:02 -04:00
keybindings.el version-control: change function prefix to spacemacs 2016-07-06 21:12:02 -04:00
packages.el Rename and add missing definition of version-control-diff-side 2016-11-05 13:03:23 +02:00
README.org Rename and add missing definition of version-control-diff-side 2016-11-05 13:03:23 +02:00

Version-Control layer

Description

This layers adds general configuration for Emacs VC. It should work with all VC backends such as Git, Mercurial, Bazaar, SVN, etc…

Features

  • highlights uncommitted changes in the fringe or margin with diff-hl,

git-gutter, or git-gutter+

  • adds vcs transient-state SPC g. to allow quick navigation and modification of

buffer hunks.

Install

Layer

To use this configuration layer, add it to your ~/.spacemacs. You will need to add version-control to the existing dotspacemacs-configuration-layers list in this file.

Configuration

You can choose the package to facilitate the diff transient-state and show margins by setting version-control-diff-tool

'(version-control :variables
                  version-control-diff-tool 'diff-hl)

You can choose the side on which the diff appears (by default it's the right side)

'(version-control :variables
                  version-control-diff-side 'left)

To automatically enable diff margins in all buffers, set version-control-global-margin

'(version-control :variables
                  version-control-global-margin t)

Differences between margin programs

This layer contains generalized mappings for three diff margin packages: diff-hl, git-gutter, and git-gutter+.

There are some differences between packages that might have some people prefer one over the other:

Feature diff-hl git-gutter git-gutter+
Show in fringe X X X
Extended VCS support (e.g. hg, svn) X X
Stage hunks from buffer X X
Dired support X

Key Bindings

Key Binding Description
SPC g . version control transient-state
SPC T d toggle diff margins
SPC T C-d toggle diff margins globally

Version Control Transient-state

Key Binding Description
SPC g . h Show diff of hunk
SPC g . n Next hunk
SPC g . N Previous hunk
SPC g . p Previous hunk
SPC g . r Revert hunk
SPC g . s Stage hunk
SPC g . t Toggle margin indicators
SPC g . w Stage file
SPC g . u Unstage file
SPC g . d Repo diff popup
SPC g . D Show diffs of unstaged hunks
SPC g . c Commit with popup
SPC g . C Commit
SPC g . P Push repo with popup
SPC g . f Fetch for repo with popup
SPC g . F Pull repo with popup
SPC g . l Show repo log