Skip to content

Commit 99c2fbe

Browse files
committed
docs/src/extensions/all-extensions: add overlays extension entry
1 parent 5b9020e commit 99c2fbe

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

docs/src/extensions/all-extensions.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,3 +135,42 @@ This section describes all official Denix extensions.
135135

136136
## User {#user}
137137
WIP
138+
139+
## Overlays {#overlays}
140+
<table class="extension-table">
141+
<tbody>
142+
<tr>
143+
<th>Name</th>
144+
<td><code>overlays</code></td>
145+
</tr>
146+
<tr>
147+
<th>Description</th>
148+
<td>Simplified overlay configuration module</td>
149+
</tr>
150+
<tr>
151+
<th>Maintainers</th>
152+
<td>Zonni (<a href='https://github.com/mzonski'>GitHub</a>)</td>
153+
</tr>
154+
</tbody>
155+
</table>
156+
157+
### Settings {#overlays-settings}
158+
| Name | Default Value | Description |
159+
| - | - | - |
160+
| `defaultTargets` | `["nixos" "home"]` | Default targets to apply overlays |
161+
| `moduleNamePrefix` | `"overlays"` | Prefix added to module names when `withPrefix` is true |
162+
163+
### Library {#overlays-library}
164+
165+
#### `overlayModule` {#overlays-library-overlayModule}
166+
Creates a module that applies overlays for specified targets. If `withPrefix` is true, it creates the option `${moduleNamePrefix}.${name}.enable` with the value `delib.overlayModule :: enabled`; otherwise, it does the same but in `${name}.enable`.
167+
168+
**Arguments:**
169+
| Name | Type | Default Value | Description |
170+
| - | - | - | - |
171+
| `name` | string | *required* | Name of the overlay module |
172+
| `overlay` | overlay function | `null` | Single overlay function to apply |
173+
| `overlays` | list of overlay functions | `[]` | List of overlay functions to apply |
174+
| `targets` | list of strings | [`defaultTargets`](#overlays-settings) | Target systems to apply overlays to. Valid values: `"nixos"`, `"home"`, `"darwin"` |
175+
| `withPrefix` | boolean | `true` | Whether to add `moduleNamePrefix` to the module name |
176+
| `enabled` | boolean | `true` | Whether overlay should be enabled by default |

0 commit comments

Comments
 (0)