diff options
| author | Profpatsch <mail@profpatsch.de> | 2017-10-31 14:55:51 +0100 |
|---|---|---|
| committer | Profpatsch <mail@profpatsch.de> | 2017-11-05 15:56:32 +0100 |
| commit | c85f085062a09369a471eec438f86f1e1d2a721e (patch) | |
| tree | b9cd7e09d8f7b5a7be721dec7a281796f9e6101b /nixos/doc/manual/development | |
| parent | f8e6cd3465c6efdfd3b9db510c6365c31740644c (diff) | |
| download | nixpkgs-c85f085062a09369a471eec438f86f1e1d2a721e.tar nixpkgs-c85f085062a09369a471eec438f86f1e1d2a721e.tar.gz nixpkgs-c85f085062a09369a471eec438f86f1e1d2a721e.tar.bz2 nixpkgs-c85f085062a09369a471eec438f86f1e1d2a721e.tar.lz nixpkgs-c85f085062a09369a471eec438f86f1e1d2a721e.tar.xz nixpkgs-c85f085062a09369a471eec438f86f1e1d2a721e.tar.zst nixpkgs-c85f085062a09369a471eec438f86f1e1d2a721e.zip | |
lib/types: update docs to match the new type names
Diffstat (limited to 'nixos/doc/manual/development')
| -rw-r--r-- | nixos/doc/manual/development/option-types.xml | 32 |
1 files changed, 9 insertions, 23 deletions
diff --git a/nixos/doc/manual/development/option-types.xml b/nixos/doc/manual/development/option-types.xml index ccdbc0900be..0b00f7077c2 100644 --- a/nixos/doc/manual/development/option-types.xml +++ b/nixos/doc/manual/development/option-types.xml @@ -35,19 +35,16 @@ </varlistentry> </variablelist> -<para>Integer related types:</para> +<para>Integer-related types:</para> <variablelist> <varlistentry> - <term> - <varname>types.ints.signed</varname> - </term> - <listitem><para>A signed integer. - </para></listitem> + <term><varname>types.int</varname></term> + <listitem><para>A signed integer.</para></listitem> </varlistentry> <varlistentry> <term> - <varname>types.ints{signed8, signed16, signed32}</varname> + <varname>types.ints.{s8, s16, s32}</varname> </term> <listitem> <para>Signed integers with a fixed length (8, 16 or 32 bits). @@ -61,20 +58,15 @@ </para></listitem> </varlistentry> <varlistentry> - <term><varname>types.int</varname></term> - <listitem><para>A convenience alias for <literal>ints.signed</literal>. - </para></listitem> - </varlistentry> - <varlistentry> <term> <varname>types.ints.unsigned</varname> </term> - <listitem><para>An unsigned integer (that is ≥ 0). + <listitem><para>An unsigned integer (that is >= 0). </para></listitem> </varlistentry> <varlistentry> <term> - <varname>types.ints{unsigned8, unsigned16, unsigned32}</varname> + <varname>types.ints.{u8, u16, u32}</varname> </term> <listitem> <para>Unsigned integers with a fixed length (8, 16 or 32 bits). @@ -86,15 +78,9 @@ for 8 bits). </para></listitem> </varlistentry> - <varlistentry> - <term> - <varname>types.port</varname> - </term> - <listitem><para>A network port number (0–65635).</para></listitem> - </varlistentry> </variablelist> -<para>String related types:</para> +<para>String-related types:</para> <variablelist> <varlistentry> @@ -123,7 +109,7 @@ <section><title>Value Types</title> - <para>Value types are type that take a value parameter.</para> + <para>Value types are types that take a value parameter.</para> <variablelist> <varlistentry> @@ -147,7 +133,7 @@ </term> <listitem><para>An integer between <replaceable>lowest</replaceable> and <replaceable>highest</replaceable> (both inclusive). - Useful for e.g. creating types like <literal>types.port</literal>. + Useful for creating types like <literal>types.port</literal>. </para></listitem> </varlistentry> <varlistentry> |