Skip to content

Commit f5f1e2d

Browse files
committed
docs: update api references
1 parent 0c03b8a commit f5f1e2d

4 files changed

+19
-98
lines changed

doc/api-reference-channels.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ nix flake
5757
## channels.\<name\>.overlays
5858
overlays to apply to this channel
5959
these will get exported under the 'overlays' flake output
60-
as \<channel\>/\<name\> and any overlay pulled from ${inputs}
60+
as \<channel\>/\<name\> and any overlay pulled from \<inputs\>
6161
will be filtered out
6262

6363

@@ -73,3 +73,19 @@ list of valid Nixpkgs overlay or path convertible to its or anything convertible
7373

7474

7575

76+
## channels.\<name\>.patches
77+
patches to apply to this channel
78+
79+
80+
*_Type_*:
81+
list of paths
82+
83+
84+
*_Default_*
85+
```
86+
[]
87+
```
88+
89+
90+
91+

doc/api-reference-home.md

-48
Original file line numberDiff line numberDiff line change
@@ -101,54 +101,6 @@ list of valid modules or anything convertible to it or path convertible to it
101101

102102

103103

104-
## home.profiles
105-
WARNING: The 'suites' and `profiles` options have been deprecated, you can now create
106-
both with the importables option. `rakeLeaves` can be used to create profiles and
107-
by passing a module or `rec` set to `importables`, suites can access profiles.
108-
Example:
109-
```
110-
importables = rec {
111-
profiles = digga.lib.rakeLeaves ./profiles;
112-
suites = with profiles; { };
113-
}
114-
```
115-
See https://github.com/divnix/digga/pull/30 for more details
116-
117-
118-
*_Type_*:
119-
list of paths or path convertible to it
120-
121-
122-
*_Default_*
123-
```
124-
[]
125-
```
126-
127-
128-
129-
130-
## home.suites
131-
WARNING: The 'suites' and `profiles` options have been deprecated, you can now create
132-
both with the importables option. `rakeLeaves` can be used to create profiles and
133-
by passing a module or `rec` set to `importables`, suites can access profiles.
134-
Example:
135-
```
136-
importables = rec {
137-
profiles = digga.lib.rakeLeaves ./profiles;
138-
suites = with profiles; { };
139-
}
140-
```
141-
See https://github.com/divnix/digga/pull/30 for more details
142-
143-
144-
*_Type_*:
145-
function that evaluates to a(n) attrs or path convertible to it
146-
147-
148-
149-
150-
151-
152104
## home.users
153105
HM users that can be deployed portably without a host.
154106

doc/api-reference-nixos.md

-48
Original file line numberDiff line numberDiff line change
@@ -232,51 +232,3 @@ null
232232

233233

234234

235-
## nixos.profiles
236-
WARNING: The 'suites' and `profiles` options have been deprecated, you can now create
237-
both with the importables option. `rakeLeaves` can be used to create profiles and
238-
by passing a module or `rec` set to `importables`, suites can access profiles.
239-
Example:
240-
```
241-
importables = rec {
242-
profiles = digga.lib.rakeLeaves ./profiles;
243-
suites = with profiles; { };
244-
}
245-
```
246-
See https://github.com/divnix/digga/pull/30 for more details
247-
248-
249-
*_Type_*:
250-
list of paths or path convertible to it
251-
252-
253-
*_Default_*
254-
```
255-
[]
256-
```
257-
258-
259-
260-
261-
## nixos.suites
262-
WARNING: The 'suites' and `profiles` options have been deprecated, you can now create
263-
both with the importables option. `rakeLeaves` can be used to create profiles and
264-
by passing a module or `rec` set to `importables`, suites can access profiles.
265-
Example:
266-
```
267-
importables = rec {
268-
profiles = digga.lib.rakeLeaves ./profiles;
269-
suites = with profiles; { };
270-
}
271-
```
272-
See https://github.com/divnix/digga/pull/30 for more details
273-
274-
275-
*_Type_*:
276-
function that evaluates to a(n) attrs or path convertible to it
277-
278-
279-
280-
281-
282-

doc/api-reference.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
- [Home](./api-reference-home.md)
66
- [Devshell](./api-reference-devshell.md)
77
- [NixOS](./api-reference-nixos.md)
8+
- [Darwin](./api-reference-darwin.md)
89

910
## channelsConfig
1011
nixpkgs config for all channels
@@ -39,7 +40,7 @@ The builder gets passed an attrset of all channels
3940

4041

4142
*_Type_*:
42-
function that evaluates to a(n) attrs or path convertible to it
43+
function that evaluates to a(n) attribute set or path convertible to it
4344

4445

4546
*_Default_*

0 commit comments

Comments
 (0)