From 3308fb37181e9d8cbcbd814e9078aedd96835636 Mon Sep 17 00:00:00 2001 From: Niklas Carlsson Date: Mon, 13 Jan 2020 09:54:22 +0100 Subject: [PATCH] Minor updates to documentation - Update the keybinding for +doom/help-autodefs - Remove silver_search from the lookup module. Ripgrep is the supported dependency. --- docs/getting_started.org | 2 +- modules/tools/lookup/README.org | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/getting_started.org b/docs/getting_started.org index ec0aa41d4..495ef2828 100644 --- a/docs/getting_started.org +++ b/docs/getting_started.org @@ -944,7 +944,7 @@ a module. For example: *** Module settings Some modules expose settings that can be configured from other modules. Use ~M-x -doom/help-autdefs~ (=SPC h d a= or =C-h d a=) to see what is available and how +doom/help-autdefs~ (=SPC h d u= or =C-h d u=) to see what is available and how to use them. An example would be the ~set-company-backend!~ function that the =:completion diff --git a/modules/tools/lookup/README.org b/modules/tools/lookup/README.org index c541cba8b..05fdda993 100644 --- a/modules/tools/lookup/README.org +++ b/modules/tools/lookup/README.org @@ -46,13 +46,13 @@ up definitions, references and documentation. * Prerequisites This module has several soft dependencies: -+ ~the_silver_searcher~ or ~ripgrep~ (recommended) as a last-resort fallback for ++ ~ripgrep~ as a last-resort fallback for jump-to-definition/find-references. + ~sqlite3~ for Dash docset support. ** MacOS #+BEGIN_SRC sh -brew install the_silver_searcher ripgrep +brew install ripgrep # An older version of sqlite is included in MacOS. If it causes you problems (and # folks have reported it will), install it through homebrew: @@ -64,7 +64,7 @@ export PATH="/usr/local/opt/sqlite/bin:$PATH" ** Arch Linux #+BEGIN_SRC sh -sudo pacman -S sqlite the_silver_searcher ripgrep +sudo pacman -S sqlite ripgrep #+END_SRC * Features @@ -79,7 +79,7 @@ following sources before giving up: ~:lookup~ setting (see "Configuration" section). 2. Any available xref backends. 3. ~dumb-jump~ (a text search with aides to reduce false positives). -3. An ordinary project-wide text search with ripgrep or the_silver_searcher. +3. An ordinary project-wide text search with ripgrep. 5. If ~evil-mode~ is active, use ~evil-goto-definition~, which preforms a simple text search within the current buffer. @@ -95,7 +95,7 @@ will try: 1. Whatever ~:references~ function is registered for the current buffer with the ~:lookup~ setting (see "Configuration" section). 2. Any available xref backends. -3. An ordinary project-wide text search with ripgrep or the_silver_searcher. +3. An ordinary project-wide text search with ripgrep. If there are multiple results, you will be prompted to select one.