nixos/manual: rename "Configuration Syntax" section to "Options Management" [WIP] #57675
+27
−28
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.
Motivation for this change
The current sections under Section II: Configuration of the NixOS Manual are as follows:
I propose changing the title of the "Configuration Syntax" section to "Options Management."
Although renaming the section involves some minor changes to its contents, this should make its contents much more easily discovered by new users of NixOS reading the Table of Contents.
In addition to better matching the contents of the section, it would allow for new sub-sections to be made in the future to further document the options management process, since the currently-named "Configuration Syntax" section is the best place in the manual to do so.
The reason for proposing this is #49899: better document
nixos-options
. If we rename this section, it would allow us to, in the future, add a subsection to specifically document accessing option values, among other things.Most of the contents for a hypothetical "Accessing Option Values" section values is already written, found in [5.3 Modularity]. A dedicated section in the future would allow for further elaboration along with being more discoverable for readers who have not read the manual from start to finish (i.e. most, if not all, non-advanced users of NixOS, I assume).
Things done
sandbox
innix.conf
on non-NixOS)nix-shell -p nox --run "nox-review wip"
./result/bin/
)nix path-info -S
before and after)Since this is a non-minor change, I assume that I will likely have to make some changes based on feedback, assuming this is eligible for being merged at all. Because of this, I marked the title with
[WIP]