[skip changelog] Correct documentation re: default for build_cache.path configuration key
#2919
Conversation
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
…ath` configuration key The "Configuration" documentation page includes information on the default values of the configuration keys. The default value of the build_cache.path configuration key was recently changed, but the documentation was not updated accordingly. The documentation is hereby updated to provide the correct information regarding the default value of the build_cache.path configuration key. Previously, the information was provided in the list of keys. That is a non-standard location for the information as there is an established convention of instead providing this information in the separate section of the page dedicated to documenting default paths. In addition. the location in the keys list became more problematic for the new default since it is operating system-specific and thus the increased volume of documentation content would be awkward to fit into the nested list of keys. For these reasons, the documentation content was moved to the standardized location under the "Default directories" section of the page.
alessio-perugini
approved these changes
May 28, 2025
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.
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)configuration.schema.jsonupdated if new parameters are added.What kind of change does this PR introduce?
Docs fix
What is the current behavior?
The "Configuration" documentation page includes information on the default values of the configuration keys.
The default value of the build_cache.path configuration key was recently changed (#2673), but the documentation was not updated accordingly so it provides incorrect information regarding the default build cache location.
What is the new behavior?
The documentation is updated to provide the correct information regarding the default value of the
build_cache.pathconfiguration key.Previously, the information was provided in the list of keys. That is a non-standard location for the information as there is an established convention of instead providing this information in the separate section of the page dedicated to documenting default paths. In addition. the location in the keys list became more problematic for the new default since it is operating system-specific and thus the increased volume of documentation content would be awkward to fit into the nested list of keys. For these reasons, the documentation content was moved to the standardized location under the "Default directories" section of the page.
Does this PR introduce a breaking change, and is titled accordingly?
No breaking change.