branch: externals/gtags-mode
commit db8eb5d566c33ceb46650e45d85b569dc3ed5930
Author: Jimmy Aguilar Mena <kratsbinov...@gmail.com>
Commit: Jimmy Aguilar Mena <kratsbinov...@gmail.com>
Improve Readme.md
---
Readme.md | 29 ++++++++++++++++-------------
gtags-mode.el | 2 +-
2 files changed, 17 insertions(+), 14 deletions(-)
diff --git a/Readme.md b/Readme.md
index 1e5b14fdc8..98092c0b06 100644
--- a/Readme.md
+++ b/Readme.md
@@ -42,9 +42,9 @@ or simply
There are only 3 extra commands that the user may need to know:
-- **gtags-mode** : To enable the global minor mode.
-- **gtags-mode-create** : To create a gtags database in case it doesn't exist
for the current project.
-- **gtags-mode-update** : To manually update an existent database; specially
useful if the project has been modified outside emacs.
+- `gtags-mode` : To enable the global minor mode.
+- `gtags-mode-create` : To create a gtags database in case it doesn't exist
for the current project.
+- `gtags-mode-update` : To manually update an existent database; specially
useful if the project has been modified outside emacs.
Configuration
-------------
@@ -52,34 +52,36 @@ Configuration
This packages tries to do its best to not require user configuration.
The package provides a minimal set of configuration options in case
the global/gtags executable are not in the usual locations, so the
-user can set them. **gtags-mode-global-executable**
-**gtags-mode-gtags-executable** are buffer local configuration options
+user can set them. `gtags-mode-global-executable`
+`gtags-mode-gtags-executable` are buffer local configuration options
to set the path or names in case the user needs it or the user setup
is do special that the command `executable-find` fails searching.
-TRAMP users can use *connection-local-variables* to set these values
-per individual hosts or users if needed.
+TRAMP users can use
+[*connection-local-variable*](https://www.gnu.org/software/emacs/manual/html_node/elisp/Connection-Local-Variables.html)
+to set these values per individual hosts or users if needed.
-**gtags-mode-features** is the list of enabled features in
+`gtags-mode-features` is the list of enabled features in
gtags-mode. By default all the features: `(project xref completion
imenu hooks)` are enabled. The user only needs to remove one of these
entries and restart `gtags-mode` to disable it.
TODO: Improve the custom type for this variable in order to restrict
possible values.
-The custom variable **gtags-mode-lighter** can be used to change the
+The custom variable `gtags-mode-lighter` can be used to change the
default mode-line message to use when the mode is enabled.
The verbosity of messages printed can be controlled with
-**gtags-mode-verbose-level** higher verbose level implies more
+`gtags-mode-verbose-level` higher verbose level implies more
messages and 0 prints no messages at all (not recommended!!). The most
verbose messages are not printed in the echo area, but only in the
`\*Messages\*` buffer.
It is possible to pass extra arguments to update commands using the
-variable **gtags-mode-update-args**. Usually these can be used to use
-different **global** backends. For example, to use *exuberant-gtags*
-instead of the default backend, the Arch Linux configuration is:
+variable `gtags-mode-update-args`. Usually these can be used to use
+different `global` backends. For example, to use
+[universal-ctags](https://ctags.io/) instead of the default backend,
+the Arch Linux configuration is:
```lisp
(setq gtags-mode-update-args "--gtagsconf=/usr/share/gtags/gtags.conf
--gtagslabel=universal-ctags")
@@ -90,3 +92,4 @@ This variable can be set in the
[*.dir-locals*](https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html)
or as a
[*connection-local-variable*](https://www.gnu.org/software/emacs/manual/html_node/elisp/Connection-Local-Variables.html)
+
diff --git a/gtags-mode.el b/gtags-mode.el
index 5e5d589329..92b75e6945 100644
--- a/gtags-mode.el
+++ b/gtags-mode.el
@@ -5,7 +5,7 @@
;; Author: Jimmy Aguilar Mena
;; URL: https://github.com/Ergus/gtags-mode
;; Keywords: xref, project, imenu, gtags, global
-;; Version: 1.8.5
+;; Version: 1.8.6
;; Package-Requires: ((emacs "28"))
;; This program is free software: you can redistribute it and/or modify
