tangled
alpha
login
or
join now
pyrox.dev
/
nixpkgs
0
fork
atom
lol
0
fork
atom
overview
issues
pulls
pipelines
lib/types: update docs to match the new type names
Profpatsch
8 years ago
c85f0850
f8e6cd34
+33
-23
5 changed files
expand all
collapse all
unified
split
lib
tests
modules
declare-int-between-value.nix
declare-int-unsigned-value.nix
define-value-int-negative.nix
define-value-int-positive.nix
nixos
doc
manual
development
option-types.xml
+9
lib/tests/modules/declare-int-between-value.nix
reviewed
···
1
1
+
{ lib, ... }:
2
2
+
3
3
+
{
4
4
+
options = {
5
5
+
value = lib.mkOption {
6
6
+
type = lib.types.ints.between (-21) 43;
7
7
+
};
8
8
+
};
9
9
+
}
+9
lib/tests/modules/declare-int-unsigned-value.nix
reviewed
···
1
1
+
{ lib, ... }:
2
2
+
3
3
+
{
4
4
+
options = {
5
5
+
value = lib.mkOption {
6
6
+
type = lib.types.ints.unsigned;
7
7
+
};
8
8
+
};
9
9
+
}
+3
lib/tests/modules/define-value-int-negative.nix
reviewed
···
1
1
+
{
2
2
+
value = -23;
3
3
+
}
+3
lib/tests/modules/define-value-int-positive.nix
reviewed
···
1
1
+
{
2
2
+
value = 42;
3
3
+
}
+9
-23
nixos/doc/manual/development/option-types.xml
reviewed
···
35
35
</varlistentry>
36
36
</variablelist>
37
37
38
38
-
<para>Integer related types:</para>
38
38
+
<para>Integer-related types:</para>
39
39
40
40
<variablelist>
41
41
<varlistentry>
42
42
-
<term>
43
43
-
<varname>types.ints.signed</varname>
44
44
-
</term>
45
45
-
<listitem><para>A signed integer.
46
46
-
</para></listitem>
42
42
+
<term><varname>types.int</varname></term>
43
43
+
<listitem><para>A signed integer.</para></listitem>
47
44
</varlistentry>
48
45
<varlistentry>
49
46
<term>
50
50
-
<varname>types.ints{signed8, signed16, signed32}</varname>
47
47
+
<varname>types.ints.{s8, s16, s32}</varname>
51
48
</term>
52
49
<listitem>
53
50
<para>Signed integers with a fixed length (8, 16 or 32 bits).
···
58
55
</inlineequation>
59
56
respectively (e.g. <literal>−128</literal> to <literal>127</literal>
60
57
for 8 bits).
61
61
-
</para></listitem>
62
62
-
</varlistentry>
63
63
-
<varlistentry>
64
64
-
<term><varname>types.int</varname></term>
65
65
-
<listitem><para>A convenience alias for <literal>ints.signed</literal>.
66
58
</para></listitem>
67
59
</varlistentry>
68
60
<varlistentry>
69
61
<term>
70
62
<varname>types.ints.unsigned</varname>
71
63
</term>
72
72
-
<listitem><para>An unsigned integer (that is ≥ 0).
64
64
+
<listitem><para>An unsigned integer (that is >= 0).
73
65
</para></listitem>
74
66
</varlistentry>
75
67
<varlistentry>
76
68
<term>
77
77
-
<varname>types.ints{unsigned8, unsigned16, unsigned32}</varname>
69
69
+
<varname>types.ints.{u8, u16, u32}</varname>
78
70
</term>
79
71
<listitem>
80
72
<para>Unsigned integers with a fixed length (8, 16 or 32 bits).
···
86
78
for 8 bits).
87
79
</para></listitem>
88
80
</varlistentry>
89
89
-
<varlistentry>
90
90
-
<term>
91
91
-
<varname>types.port</varname>
92
92
-
</term>
93
93
-
<listitem><para>A network port number (0–65635).</para></listitem>
94
94
-
</varlistentry>
95
81
</variablelist>
96
82
97
97
-
<para>String related types:</para>
83
83
+
<para>String-related types:</para>
98
84
99
85
<variablelist>
100
86
<varlistentry>
···
123
109
124
110
<section><title>Value Types</title>
125
111
126
126
-
<para>Value types are type that take a value parameter.</para>
112
112
+
<para>Value types are types that take a value parameter.</para>
127
113
128
114
<variablelist>
129
115
<varlistentry>
···
147
133
</term>
148
134
<listitem><para>An integer between <replaceable>lowest</replaceable>
149
135
and <replaceable>highest</replaceable> (both inclusive).
150
150
-
Useful for e.g. creating types like <literal>types.port</literal>.
136
136
+
Useful for creating types like <literal>types.port</literal>.
151
137
</para></listitem>
152
138
</varlistentry>
153
139
<varlistentry>