diff options
author | Janne Heß <janne@hess.ooo> | 2021-06-16 12:27:47 +0200 |
---|---|---|
committer | Silvan Mosberger <contact@infinisil.com> | 2022-02-28 22:51:41 +0100 |
commit | 0c766a100e416611807a184ee35a0edbd11b15a4 (patch) | |
tree | 7eaf0b6814b5d18675da97ef9339d7f98d89b4d9 /nixos/doc/manual/from_md/development | |
parent | b2d803ca57ef06b3f681db109d7f6069b2eb9bc1 (diff) | |
download | nixpkgs-0c766a100e416611807a184ee35a0edbd11b15a4.tar nixpkgs-0c766a100e416611807a184ee35a0edbd11b15a4.tar.gz nixpkgs-0c766a100e416611807a184ee35a0edbd11b15a4.tar.bz2 nixpkgs-0c766a100e416611807a184ee35a0edbd11b15a4.tar.lz nixpkgs-0c766a100e416611807a184ee35a0edbd11b15a4.tar.xz nixpkgs-0c766a100e416611807a184ee35a0edbd11b15a4.tar.zst nixpkgs-0c766a100e416611807a184ee35a0edbd11b15a4.zip |
lib/options: Throw error for options without a type
Makes all options rendered in the manual throw an error if they don't have a type specified. This is a follow-up to #76184 Co-Authored-By: Silvan Mosberger <contact@infinisil.com>
Diffstat (limited to 'nixos/doc/manual/from_md/development')
-rw-r--r-- | nixos/doc/manual/from_md/development/option-declarations.section.xml | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/nixos/doc/manual/from_md/development/option-declarations.section.xml b/nixos/doc/manual/from_md/development/option-declarations.section.xml index 0eeffae628e..c7b62192158 100644 --- a/nixos/doc/manual/from_md/development/option-declarations.section.xml +++ b/nixos/doc/manual/from_md/development/option-declarations.section.xml @@ -38,9 +38,11 @@ options = { <listitem> <para> The type of the option (see - <xref linkend="sec-option-types" />). It may be omitted, but - that’s not advisable since it may lead to errors that are hard - to diagnose. + <xref linkend="sec-option-types" />). This argument is + mandatory for nixpkgs modules. Setting this is highly + recommended for the sake of documentation and type checking. + In case it is not set, a fallback type with unspecified + behavior is used. </para> </listitem> </varlistentry> |