Skip to content

Commit 6d5ed48

Browse files
avargitster
authored andcommitted
git{,-blame}.el: remove old bitrotting Emacs code
The git-blame.el mode has been superseded by Emacs's own vc-annotate (invoked by C-x v g). Users of the git.el mode are now much better off using either Magit or the Git backend for Emacs's own VC mode. These modes were added over 10 years ago when Emacs's own Git support was much less mature, and there weren't other mature modes in the wild or shipped with Emacs itself. These days these modes have few if any users, and users of git aren't well served by us shipping these (some OS's install them alongside git by default, which is confusing and leads users astray). So let's remove these per Alexandre Julliard's message to the ML[1]. If someone still wants these for some reason they're better served by hosting these elsewhere (e.g. on ELPA), instead of us distributing them with git. However, since downstream packagers such as Debian are packaging this as git-el it's less disruptive to still carry these files as Elisp code that'll error out with a message suggesting alternatives, rather than drop the files entirely[2]. Then rather than receive a cryptic load error when they upgrade existing users will get an error directing them to the README file, or to just stop requiring these modes. I think it makes sense to link to GitHub's hosting of contrib/emacs/README (which'll be updated by the time users see this) so they don't have to hunt down the packaged README on their local system. 1. "Re: [PATCH] git.el: handle default excludesfile properly" ([email protected]) -- https://public-inbox.org/git/[email protected]/ 2. "Re: [PATCH v3] git{,-blame}.el: remove old bitrotting Emacs code" ([email protected]) -- https://public-inbox.org/git/[email protected]/ Signed-off-by: Ævar Arnfjörð Bjarmason <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent d0db9ed commit 6d5ed48

File tree

5 files changed

+25
-2228
lines changed

5 files changed

+25
-2228
lines changed

contrib/emacs/.gitignore

-1
This file was deleted.

contrib/emacs/Makefile

-21
This file was deleted.

contrib/emacs/README

+13-19
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,24 @@
1-
This directory contains various modules for Emacs support.
1+
This directory used to contain various modules for Emacs support.
22

3-
To make the modules available to Emacs, you should add this directory
4-
to your load-path, and then require the modules you want. This can be
5-
done by adding to your .emacs something like this:
3+
These were added shortly after Git was first released. Since then
4+
Emacs's own support for Git got better than what was offered by these
5+
modes. There are also popular 3rd-party Git modes such as Magit which
6+
offer replacements for these.
67

7-
(add-to-list 'load-path ".../git/contrib/emacs")
8-
(require 'git)
9-
(require 'git-blame)
10-
11-
12-
The following modules are available:
8+
The following modules were available, and can be dug up from the Git
9+
history:
1310

1411
* git.el:
1512

16-
Status manager that displays the state of all the files of the
17-
project, and provides easy access to the most frequently used git
18-
commands. The user interface is as far as possible compatible with
19-
the pcl-cvs mode. It can be started with `M-x git-status'.
13+
Wrapper for "git status" that provided access to other git commands.
14+
15+
Modern alternatives to this include Magit, and VC mode that ships
16+
with Emacs.
2017

2118
* git-blame.el:
2219

23-
Emacs implementation of incremental git-blame. When you turn it on
24-
while viewing a file, the editor buffer will be updated by setting
25-
the background of individual lines to a color that reflects which
26-
commit it comes from. And when you move around the buffer, a
27-
one-line summary will be shown in the echo area.
20+
A wrapper for "git blame" written before Emacs's own vc-annotate
21+
mode learned to invoke git-blame, which can be done via C-x v g.
2822

2923
* vc-git.el:
3024

0 commit comments

Comments
 (0)