From: Alexandre Julliard Date: Mon, 16 Feb 2009 10:40:29 +0000 (+0100) Subject: Add a README in the contrib/emacs directory. X-Git-Tag: v1.6.2-rc2~16^2 X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=6f3c504b54e93772e875b6210fe69ecbad978e78;p=git.git Add a README in the contrib/emacs directory. Signed-off-by: Alexandre Julliard --- diff --git a/contrib/emacs/README b/contrib/emacs/README new file mode 100644 index 000000000..82368bdbf --- /dev/null +++ b/contrib/emacs/README @@ -0,0 +1,39 @@ +This directory contains various modules for Emacs support. + +To make the modules available to Emacs, you should add this directory +to your load-path, and then require the modules you want. This can be +done by adding to your .emacs something like this: + + (add-to-list 'load-path ".../git/contrib/emacs") + (require 'git) + (require 'git-blame) + + +The following modules are available: + +* git.el: + + Status manager that displays the state of all the files of the + project, and provides easy access to the most frequently used git + commands. The user interface is as far as possible compatible with + the pcl-cvs mode. It can be started with `M-x git-status'. + +* git-blame.el: + + Emacs implementation of incremental git-blame. When you turn it on + while viewing a file, the editor buffer will be updated by setting + the background of individual lines to a color that reflects which + commit it comes from. And when you move around the buffer, a + one-line summary will be shown in the echo area. + +* vc-git.el: + + This file used to contain the VC-mode backend for git, but it is no + longer distributed with git. It is now maintained as part of Emacs + and included in standard Emacs distributions starting from version + 22.2. + + If you have an earlier Emacs version, upgrading to Emacs 22 is + recommended, since the VC mode in older Emacs is not generic enough + to be able to support git in a reasonable manner, and no attempt has + been made to backport vc-git.el.