diff options
| author | Silvan Mosberger <contact@infinisil.com> | 2022-03-02 18:29:44 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-02 18:29:44 +0100 |
| commit | c1dfec2be66a995dbf6c73e01b3d07a2adf5788b (patch) | |
| tree | 54b7f1d5a3b522a624a0b1093a6c27294291bf81 /nixos | |
| parent | bff70d25ffb12e24451f3015ca5aae83284b34ba (diff) | |
| parent | 023fa7b9239e645f7dfcbbe3ee82ab0093f9978d (diff) | |
| download | nixlib-c1dfec2be66a995dbf6c73e01b3d07a2adf5788b.tar nixlib-c1dfec2be66a995dbf6c73e01b3d07a2adf5788b.tar.gz nixlib-c1dfec2be66a995dbf6c73e01b3d07a2adf5788b.tar.bz2 nixlib-c1dfec2be66a995dbf6c73e01b3d07a2adf5788b.tar.lz nixlib-c1dfec2be66a995dbf6c73e01b3d07a2adf5788b.tar.xz nixlib-c1dfec2be66a995dbf6c73e01b3d07a2adf5788b.tar.zst nixlib-c1dfec2be66a995dbf6c73e01b3d07a2adf5788b.zip | |
Merge pull request #149689 from Infinisil/types-type
Introduce `types.optionType` and use it for `freeformType`
Diffstat (limited to 'nixos')
| -rw-r--r-- | nixos/doc/manual/development/option-types.section.md | 7 | ||||
| -rw-r--r-- | nixos/doc/manual/from_md/development/option-types.section.xml | 14 |
2 files changed, 21 insertions, 0 deletions
diff --git a/nixos/doc/manual/development/option-types.section.md b/nixos/doc/manual/development/option-types.section.md index 78ace62e8f17..071e7751eb67 100644 --- a/nixos/doc/manual/development/option-types.section.md +++ b/nixos/doc/manual/development/option-types.section.md @@ -74,6 +74,13 @@ merging is handled. should only be used when checking, merging and nested evaluation are not desirable. +`types.optionType` + +: The type of an option's type. Its merging operation ensures that nested + options have the correct file location annotated, and that if possible, + multiple option definitions are correctly merged together. The main use + case is as the type of the `_module.freeformType` option. + `types.attrs` : A free-form attribute set. diff --git a/nixos/doc/manual/from_md/development/option-types.section.xml b/nixos/doc/manual/from_md/development/option-types.section.xml index 90ef05a24e77..50a3da0ef5bb 100644 --- a/nixos/doc/manual/from_md/development/option-types.section.xml +++ b/nixos/doc/manual/from_md/development/option-types.section.xml @@ -113,6 +113,20 @@ </varlistentry> <varlistentry> <term> + <literal>types.optionType</literal> + </term> + <listitem> + <para> + The type of an option’s type. Its merging operation ensures + that nested options have the correct file location + annotated, and that if possible, multiple option definitions + are correctly merged together. The main use case is as the + type of the <literal>_module.freeformType</literal> option. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> <literal>types.attrs</literal> </term> <listitem> |