golang/delve
1
0
Fork 0
mirror of https://github.com/go-delve/delve.git synced 2025-10-29 01:27:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

terminal/docgen: Specify all possible config locations (#1859)

Browse Source 
Changes docs to reflect different possible locations for config/history files.
This commit is contained in:
vpsx
2020-02-12 10:59:37 -06:00
committed by GitHub
parent d8c31af4b0
commit abb57ff017
2 changed files with 8 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation/cli/README.md
View File

@ -1,11 +1,8 @@
# Configuration
# Configuration and Command History
Delve can be configured via the configuration file located in `$HOME/.config/dlv/config.yml`.
You can open the file and discover all the configurable options and their default value.
If `$XDG_CONFIG_HOME` is set, then configuration and command history files are located in `$XDG_CONFIG_HOME/dlv`. Otherwise, they are located in `$HOME/.config/dlv` on Linux and `$HOME/.dlv` on other systems.
# History
The command history of delve debugger is stored in `$HOME/.config/dlv/.dbg_history`.
The configuration file `config.yml` contains all the configurable options and their default values. The command history is stored in `.dbg_history`.
# Commands

11
pkg/terminal/docgen.go
View File

@ -27,12 +27,11 @@ func replaceDocPath(s string) string {
}
func (commands *Commands) WriteMarkdown(w io.Writer) {
fmt.Fprint(w, "# Configuration\n\n")
fmt.Fprint(w, "Delve can be configured via the configuration file located in `$HOME/.config/dlv/config.yml`.\n")
fmt.Fprint(w, "You can open the file and discover all the configurable options and their default value.\n\n")
fmt.Fprint(w, "# History\n\n")
fmt.Fprint(w, "The command history of delve debugger is stored in `$HOME/.config/dlv/.dbg_history`.\n\n")
fmt.Fprint(w, "# Configuration and Command History\n\n")
fmt.Fprint(w, "If `$XDG_CONFIG_HOME` is set, then configuration and command history files are located in `$XDG_CONFIG_HOME/dlv`. ")
fmt.Fprint(w, "Otherwise, they are located in `$HOME/.config/dlv` on Linux and `$HOME/.dlv` on other systems.\n\n")
fmt.Fprint(w, "The configuration file `config.yml` contains all the configurable options and their default values. ")
fmt.Fprint(w, "The command history is stored in `.dbg_history`.\n\n")
fmt.Fprint(w, "# Commands\n\n")