emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Minor updates to documentation

Browse source 
- Update the keybinding for +doom/help-autodefs
- Remove silver_search from the lookup module. Ripgrep is the supported
dependency.
This commit is contained in:
Niklas Carlsson 2020-01-13 09:54:22 +01:00
parent 6f273ffc25
commit 3308fb3718
2 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/getting_started.org
View file

@ -944,7 +944,7 @@ a module. For example:
*** Module settings *** Module settings
Some modules expose settings that can be configured from other modules. Use ~M-x 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. to use them.
An example would be the ~set-company-backend!~ function that the =:completion An example would be the ~set-company-backend!~ function that the =:completion

10
modules/tools/lookup/README.org
View file

@ -46,13 +46,13 @@ up definitions, references and documentation.
* Prerequisites * Prerequisites
This module has several soft dependencies: 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. jump-to-definition/find-references.
+ ~sqlite3~ for Dash docset support. + ~sqlite3~ for Dash docset support.
** MacOS ** MacOS
#+BEGIN_SRC sh #+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 # An older version of sqlite is included in MacOS. If it causes you problems (and
# folks have reported it will), install it through homebrew: # folks have reported it will), install it through homebrew:
@ -64,7 +64,7 @@ export PATH="/usr/local/opt/sqlite/bin:$PATH"
** Arch Linux ** Arch Linux
#+BEGIN_SRC sh #+BEGIN_SRC sh
sudo pacman -S sqlite the_silver_searcher ripgrep sudo pacman -S sqlite ripgrep
#+END_SRC #+END_SRC
* Features * Features
@ -79,7 +79,7 @@ following sources before giving up:
~:lookup~ setting (see "Configuration" section). ~:lookup~ setting (see "Configuration" section).
2. Any available xref backends. 2. Any available xref backends.
3. ~dumb-jump~ (a text search with aides to reduce false positives). 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 5. If ~evil-mode~ is active, use ~evil-goto-definition~, which preforms a simple
text search within the current buffer. text search within the current buffer.
@ -95,7 +95,7 @@ will try:
1. Whatever ~:references~ function is registered for the current buffer with the 1. Whatever ~:references~ function is registered for the current buffer with the
~:lookup~ setting (see "Configuration" section). ~:lookup~ setting (see "Configuration" section).
2. Any available xref backends. 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. If there are multiple results, you will be prompted to select one.