From 9033258f5f6b33f58a8a902d877b11298fe53cdc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Tue, 20 Jul 2021 14:24:11 +0200 Subject: [PATCH] Clean up GH_CONFIG_DIR docs This removes the false equivalence between GH_CONFIG_DIR and XDG_CONFIG_HOME. These settings do not have the same effect and should not be used for the same purposes. Also remove the documentation about what `XDG_*` settings do. We simply conform to the XDG Base Directory Specification, but will not document it. It's likely that users of these environment variables already know what they do. --- pkg/cmd/root/help_topic.go | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/pkg/cmd/root/help_topic.go b/pkg/cmd/root/help_topic.go index 040c9fa12..2edea8ee5 100644 --- a/pkg/cmd/root/help_topic.go +++ b/pkg/cmd/root/help_topic.go @@ -49,7 +49,8 @@ var HelpTopics = map[string]map[string]string{ DEBUG: set to any value to enable verbose output to standard error. Include values "api" or "oauth" to print detailed information about HTTP requests or authentication flow. - GH_PAGER, PAGER (in order of precedence): a terminal paging program to send standard output to, e.g. "less". + GH_PAGER, PAGER (in order of precedence): a terminal paging program to send standard output + to, e.g. "less". GLAMOUR_STYLE: the style to use for rendering Markdown. See https://github.com/charmbracelet/glamour#styles @@ -65,11 +66,8 @@ var HelpTopics = map[string]map[string]string{ checks for new releases once every 24 hours and displays an upgrade notice on standard error if a newer version was found. - GH_CONFIG_DIR, XDG_CONFIG_HOME (in order of precedence): the directory where gh will store configuration files. - - XDG_STATE_HOME: the directory where gh will store state files. - - XDG_DATA_HOME: the directory where gh will store data files. + GH_CONFIG_DIR: the directory where gh will store configuration files. Default: + "$XDG_CONFIG_HOME/gh" or "$HOME/.config/gh". `), }, "reference": {