docs(configuration): say what an empty --env entry actually does - #1218
Merged
Conversation
The guide said an empty entry in the -e/--env/--boot file "does wipe a value", which reads as "reset it to the built-in default". It assigns the empty string instead, and for a boolean that is not the default but a disabled setting: with BASHUNIT_SHOW_HEADER=true in the environment and an empty entry in the --env file, the header is hidden, where a reset to the default (true) would show it. The cause is that `.env` gets a preservation pass in config/env.sh for values the file blanks, while the --env path in main/test.sh is a plain source under allexport with no such pass. Correct the sentence, note the missing preservation pass next to the existing explanation of why the two files differ, and cover the whole six-level ladder with acceptance tests -- none of it was executed anywhere. Closes #1217
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
1 participant
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.
🤔 Background
Related #1217
The configuration guide said an empty entry in the
-e/--env/--bootfile "does wipe a value", which reads as a reset to the built-in default. It assigns the empty string, so blanking a boolean disables it instead of restoring the default — measured withBASHUNIT_SHOW_HEADER=trueambient and an empty entry: the header is hidden, where a reset to the default would show it.💡 Changes
.envhas a preservation pass for values it blanks, the--envpath is a plain source underallexportwithout one.envempty-entry preservation rule,--skip-env-fileskipping both files, and flag ordering around--env