summary refs log tree commit diff
path: root/nixos/doc/manual/from_md/development/option-types.section.xml
diff options
context:
space:
mode:
authorSilvan Mosberger <contact@infinisil.com>2021-08-02 21:42:45 +0200
committerSilvan Mosberger <contact@infinisil.com>2022-02-22 15:54:44 +0100
commit665344f14839ea286a7aeb329fbf4f44da268ce4 (patch)
treec251e98c95006eaf8162d582b1fbcf4cd57f82db /nixos/doc/manual/from_md/development/option-types.section.xml
parent67596d3fcf34ed9f8749221d0abb714069d3985b (diff)
downloadnixpkgs-665344f14839ea286a7aeb329fbf4f44da268ce4.tar
nixpkgs-665344f14839ea286a7aeb329fbf4f44da268ce4.tar.gz
nixpkgs-665344f14839ea286a7aeb329fbf4f44da268ce4.tar.bz2
nixpkgs-665344f14839ea286a7aeb329fbf4f44da268ce4.tar.lz
nixpkgs-665344f14839ea286a7aeb329fbf4f44da268ce4.tar.xz
nixpkgs-665344f14839ea286a7aeb329fbf4f44da268ce4.tar.zst
nixpkgs-665344f14839ea286a7aeb329fbf4f44da268ce4.zip
lib/types: Introduce types.raw for unprocessed values
Diffstat (limited to 'nixos/doc/manual/from_md/development/option-types.section.xml')
-rw-r--r--nixos/doc/manual/from_md/development/option-types.section.xml19
1 files changed, 19 insertions, 0 deletions
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 76ffb6f837c..90ef05a24e7 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>