feat(config-include): add optional field support #16180
Merged
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
Capture current behavior where optional field is not yet supported.
When `optional=true` Cargo silently skip missing config-include files. Example config: ```toml [[include]] path = 'optional-config.toml' optional = true ```
Restructure config-include documentation: - Brief intro with examples - Added the "Documentation updates" subsection I am a bit not sure whether we should have standalone sections like `include.path` and `include.optional`, as we cannot really set `include.path = "config.toml"` directly. Or maybe `include[].path` is good for heading?
rustbot added A-configuration 
Collaborator
3 tasks
epage approved these changes Oct 31, 2025
rustbot removed the S-waiting-on-review bors added a commit to rust-lang/rust that referenced this pull request Nov 1, 2025
Update cargo submodule 6 commits in 6c1b6100343691341b9e76c5acc594e78220f963..6368002885a04cbeae39a82cf5118f941559a40a 2025-10-28 16:27:52 +0000 to 2025-10-31 14:31:52 +0000 - feat(build-analysis): emit timing-info log (rust-lang/cargo#16179) - Remove libc pin message (rust-lang/cargo#16182) - feat(config-include): add optional field support (rust-lang/cargo#16180) - feat(config-include): support inline and array of tables (rust-lang/cargo#16174) - test(script): Update from rustc's test suite (rust-lang/cargo#16169) - Fix links for options in man pages (rust-lang/cargo#16172) r? ghost
bors added a commit to rust-lang/rust that referenced this pull request Nov 1, 2025
Update cargo submodule 6 commits in 6c1b6100343691341b9e76c5acc594e78220f963..6368002885a04cbeae39a82cf5118f941559a40a 2025-10-28 16:27:52 +0000 to 2025-10-31 14:31:52 +0000 - feat(build-analysis): emit timing-info log (rust-lang/cargo#16179) - Remove libc pin message (rust-lang/cargo#16182) - feat(config-include): add optional field support (rust-lang/cargo#16180) - feat(config-include): support inline and array of tables (rust-lang/cargo#16174) - test(script): Update from rustc's test suite (rust-lang/cargo#16169) - Fix links for options in man pages (rust-lang/cargo#16172) r? ghost
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
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.
What does this PR try to resolve?
When
optional=trueCargo silently skip missing config-include files.Example config:
Part of #7723 (comment).
How to test and review this PR?
CI passes.
In the updated doc,
I am a bit not sure whether we should have standalone sections
like
include.pathandinclude.optional,as we cannot really set
include.path = "config.toml"directly.Or maybe
include[].pathis good for heading?