Skip to content

Commit 04134cf

Browse files
committed
docs(config-include): prepare for doc stabilization
This adds introductory section explaining purpose as well as one placement note for stabilization
1 parent cf5ca00 commit 04134cf

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

src/doc/src/reference/unstable.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -660,14 +660,24 @@ rustflags = ["-W", "unsafe-code"]
660660

661661
### Documentation updates
662662

663-
#### `include`
663+
> put this after `## Command-line overrides` before `## Config-relative paths`
664+
> to emphasize its special nature than other config keys.
665+
666+
#### Including extra configuration files
667+
668+
Configuration can include other configuration files using the top-level `include` key.
669+
This allows sharing configuration across multiple projects
670+
or splitting complex configurations into multiple files.
671+
672+
##### `include`
664673

665674
* Type: array of strings (paths), or array of tables
666675
* Default: none
667676
* Environment: not supported
668677

669-
Loads additional config files. Paths are relative to the config file that
670-
includes them. Only paths ending with `.toml` are accepted.
678+
Loads additional configuration files.
679+
Paths are relative to the configuration file that includes them.
680+
Only paths ending with `.toml` are accepted.
671681

672682
Supports the following formats:
673683

0 commit comments

Comments
 (0)