diff options
| author | Silvan Mosberger <contact@infinisil.com> | 2021-08-02 21:42:45 +0200 |
|---|---|---|
| committer | Silvan Mosberger <contact@infinisil.com> | 2022-02-22 15:54:44 +0100 |
| commit | 665344f14839ea286a7aeb329fbf4f44da268ce4 (patch) | |
| tree | c251e98c95006eaf8162d582b1fbcf4cd57f82db /nixos | |
| parent | 67596d3fcf34ed9f8749221d0abb714069d3985b (diff) | |
lib/types: Introduce types.raw for unprocessed values
Diffstat (limited to 'nixos')
| -rw-r--r-- | nixos/doc/manual/development/option-types.section.md | 11 | ||||
| -rw-r--r-- | nixos/doc/manual/from_md/development/option-types.section.xml | 19 |
2 files changed, 30 insertions, 0 deletions
diff --git a/nixos/doc/manual/development/option-types.section.md b/nixos/doc/manual/development/option-types.section.md index 56ffa8e9d79c4..78ace62e8f173 100644 --- a/nixos/doc/manual/development/option-types.section.md +++ b/nixos/doc/manual/development/option-types.section.md @@ -63,6 +63,17 @@ merging is handled. ``` ::: +`types.raw` + +: A type which doesn't do any checking, merging or nested evaluation. It + accepts a single arbitrary value that is not recursed into, making it + useful for values coming from outside the module system, such as package + sets or arbitrary data. Options of this type are still evaluated according + to priorities and conditionals, so `mkForce`, `mkIf` and co. still work on + the option value itself, but not for any value nested within it. This type + should only be used when checking, merging and nested evaluation are not + desirable. + `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 76ffb6f837c35..90ef05a24e777 100644 --- a/nixos/doc/manual/from_md/development/option-types.section.xml +++ b/nixos/doc/manual/from_md/development/option-types.section.xml @@ -94,6 +94,25 @@ </varlistentry> <varlistentry> <term> + <literal>types.raw</literal> + </term> + <listitem> + <para> + A type which doesn’t do any checking, merging or nested + evaluation. It accepts a single arbitrary value that is not + recursed into, making it useful for values coming from + outside the module system, such as package sets or arbitrary + data. Options of this type are still evaluated according to + priorities and conditionals, so <literal>mkForce</literal>, + <literal>mkIf</literal> and co. still work on the option + value itself, but not for any value nested within it. This + type should only be used when checking, merging and nested + evaluation are not desirable. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> <literal>types.attrs</literal> </term> <listitem> |