Self-document the XDG_STATE_HOME fallback#1148
Merged
ko1 merged 1 commit intoruby:masterfrom Jun 17, 2025
Merged
Conversation
Merged
Collaborator
|
ok thank you! it is another idea that adding a (sub)section "Files" and describe related files. |
This was referenced Jun 18, 2025
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Followup documentation/comments for #1146
Document XDG_STATE_HOME fallback value
The RUBY_DEBUG_HISTORY_FILE has a default value of
$XDG_STATE_HOME/rdbg/historywhich is already documented. However, the fallback value for the env variableXDG_STATE_HOMEis not documented. Users who are unfamiliar with XDG basedir spec may not know that the default value for it is~/.local/state/.This change uses bash parameter expansion syntax to "self-document" the fallback value for the variable when it is unset.
Note: I used the
-default syntax, not the:-syntax. This is because the current ruby code does not check ifXDG_STATE_HOMEis empty, it merely checks if it is set. So an empty-string value would not trigger the fallback location to be used.This PR was spawned from the following discussion: #1146 (comment)