aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFlorian Fischer <florian.fischer@muhq.space>2021-12-13 13:24:01 +0100
committerFlorian Fischer <florian.fischer@muhq.space>2021-12-13 13:24:01 +0100
commit14b2a777085b60f2b0fba4cfc8407d9228758f44 (patch)
tree4b2eb70f83292184ef89333d6a07e7371fd78534 /README.md
parent45da026654b7efd744345e3ab7b769b3a8d4dbc4 (diff)
downloadvis-lspc-14b2a777085b60f2b0fba4cfc8407d9228758f44.tar.gz
vis-lspc-14b2a777085b60f2b0fba4cfc8407d9228758f44.zip
improve default logging
I use to have logging enabled to be able to debug weird vis-lspc behavior right away. But I got annoyed by vis-lspc cluttering all my directories with vis-lspc.log files. So vis-lspc will no write its log files to $XDG_DATA_HOME/vis-lspc/<iso-date>-<cwd-basename>.log if lspc.log_file is not set by the user. This patch also introduces a helper to run a program and capture its output.
Diffstat (limited to 'README.md')
-rw-r--r--README.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/README.md b/README.md
index ed990ff..a882907 100644
--- a/README.md
+++ b/README.md
@@ -104,7 +104,8 @@ Available fields are:
* `name = 'vis-lspc'` - the name vis-lspc introduces itself to a language server
* `logging = false` - enable logging only useful for debugging vis-lspc
-* `log_file = 'vis-lspc.log'` - file vis-lspc writes all log messages to
+* `log_file = nil` - nil, filename or function returning a filename
+ * If `log_file` is `nil` vis-lspc will create a new file in `$XDG_DATA_HOME/vis-lspc`
* `autostart = true` - try to start a language server in WIN_OPEN
* `menu_cmd = 'fzf' or 'vis-menu'` - program to prompt for user choices
* `confirm_cmd = 'vis-menu'` - program to prompt for user confirmation