From: Jakub Narebski <jnareb@gmail.com>
To: git@vger.kernel.org
Cc: "David Kågedal" <davidk@lysator.liu.se>
Subject: [PATCH 2/2] git-blame: Change installation instructions
Date: Wed, 7 Feb 2007 13:59:27 +0100 [thread overview]
Message-ID: <200702071359.28100.jnareb@gmail.com> (raw)
In-Reply-To: <200702071356.43020.jnareb@gmail.com>
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>
---
contrib/emacs/git-blame.el | 26 ++++++++++++++++++++++----
1 files changed, 22 insertions(+), 4 deletions(-)
diff --git a/contrib/emacs/git-blame.el b/contrib/emacs/git-blame.el
index cca0a77..7beeece 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,9 +113,14 @@
(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)
+ "Minor mode for incremental blame for Git."
(interactive "P")
(if arg
(setq git-blame-mode (eq arg 1))
@@ -244,4 +260,6 @@
(format "git log -1 --pretty=oneline %s" (or hash
(git-blame-current-commit)))))
+(provide 'git-blame)
+
;;; git-blame.el ends here
--
1.4.4.4
prev parent reply other threads:[~2007-02-07 12:58 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-02-07 12:56 [PATCH 1/2] git-blame: Add Emacs Lisp file headers and GNU GPL boilerplate Jakub Narebski
2007-02-07 12:59 ` Jakub Narebski [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=200702071359.28100.jnareb@gmail.com \
--to=jnareb@gmail.com \
--cc=davidk@lysator.liu.se \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.