Skip to content

Clean up GH_CONFIG_DIR docs#4020

Merged
mislav merged 1 commit intotrunkfrom
xdg-docs
Jul 20, 2021
Merged

Clean up GH_CONFIG_DIR docs#4020
mislav merged 1 commit intotrunkfrom
xdg-docs

Conversation

@mislav
Copy link
Contributor

@mislav mislav commented Jul 20, 2021

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.

Followup to #3768

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.
@mislav mislav requested a review from samcoe July 20, 2021 12:28
@mislav mislav merged commit 25ef111 into trunk Jul 20, 2021
@mislav mislav deleted the xdg-docs branch July 20, 2021 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants