Skip to content

Commit

Permalink
Updated Commentary section to explain xref (#350)
Browse files Browse the repository at this point in the history
  • Loading branch information
phikal committed Jul 28, 2020
1 parent acac32a commit 32ae0f5
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions dumb-jump.el
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,22 @@

;; Dumb Jump is an Emacs "jump to definition" package with support for 40+ programming languages that favors
;; "just working" over speed or accuracy. This means minimal -- and ideally zero -- configuration with absolutely
;; no stored indexes (TAGS) or persistent background processes. Dumb Jump performs best with The Silver Searcher
;; `ag` or ripgrep `rg` installed. Dumb Jump requires at least GNU Emacs 24.3.
;; no stored indexes (TAGS) or persistent background processes.
;;
;; Dumb Jump provides a xref-based interface for jumping to
;; definitions. It is based on tools such as grep, the silver searcher
;; (https://geoff.greer.fm/ag/), ripgrep
;; (https://github.com/BurntSushi/ripgrep) or git-grep
;; (https://git-scm.com/docs/git-grep).
;;
;; To enable Dumb Jump, add the following to your initialisation file:
;;
;; (add-hook 'xref-backend-functions #'dumb-jump-xref-activate)
;;
;; Now pressing M-. on an identifier should open a buffer at the place
;; where it is defined, or a list of candidates if uncertain. This
;; list can be navigated using M-g M-n (next-error) and M-g M-p
;; (previous-error).

;;; Code:
(unless (require 'xref nil :noerror)
Expand Down

0 comments on commit 32ae0f5

Please sign in to comment.