diff options
| author |  Jakub Narebski <jnareb@gmail.com> | 2007-02-09 09:19:59 +0100 |
|---|---|---|
| committer |  Junio C Hamano <junkio@cox.net> | 2007-02-09 00:52:52 -0800 |
| commit | f6f125fbaa79c097f10afdbd7103ec068df10397 (patch) | |
| tree | af33e7d9d7424479148731f53ee0f97ea67ce82a | |
| parent | git-blame: Add Emacs Lisp file headers and GNU GPL boilerplate (diff) | |
| download | tgif-f6f125fbaa79c097f10afdbd7103ec068df10397.tar.xz | |
git-blame: Change installation instructions
Change installation instructions to using either "(require 'git-blame)"
or appropriate autoload instruction in GNU Emacs init file, .emacs
This required adding "(provide 'git-blame)" at the end of git-blame.el
and adding [preliminary] docstring to `git-blame-mode' function for
consistency (to mark function as interactive in `autoload' we have to
provide docstring as DOCSTRING is third arg, and INTERACTIVE fourth,
and both are optional). `git-blame-mode' is marked to autoload.
While at it ensure that we add `git-blame-mode' to `minor-mode-alist'
only once (in a way that does not depend on `cl' package).
Signed-off-by: Jakub Narebski <jnareb@gmail.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
| -rw-r--r-- | contrib/emacs/git-blame.el | 23 |
1 files changed, 19 insertions, 4 deletions
diff --git a/contrib/emacs/git-blame.el b/contrib/emacs/git-blame.el index ba9d8a6cde..56a548b4a8 100644 --- a/contrib/emacs/git-blame.el +++ b/contrib/emacs/git-blame.el @@ -44,9 +44,20 @@ ;;; Installation: ;; -;; 1) Load into emacs: M-x load-file RET git-blame.el RET -;; 2) Open a git-controlled file -;; 3) Blame: M-x git-blame-mode +;; To use this package, put it somewhere in `load-path' (or add +;; directory with git-blame.el to `load-path'), and add the following +;; line to your .emacs: +;; +;; (require 'git-blame) +;; +;; If you do not want to load this package before it is necessary, you +;; can make use of the `autoload' feature, e.g. by adding to your .emacs +;; the following lines +;; +;; (autoload 'git-blame-mode "git-blame" +;; "Minor mode for incremental blame for Git." t) +;; +;; Then first use of `M-x git-blame-mode' would load the package. ;;; Compatibility: ;; @@ -102,8 +113,12 @@ (defvar git-blame-mode nil) (make-variable-buffer-local 'git-blame-mode) -(push (list 'git-blame-mode " blame") minor-mode-alist) +(unless (assq 'git-blame-mode minor-mode-alist) + (setq minor-mode-alist + (cons (list 'git-blame-mode " blame") + minor-mode-alist))) +;;;###autoload (defun git-blame-mode (&optional arg) (interactive "P") (if arg |