pyrox.dev
1# Meta Attributes {#sec-meta-attributes}
2
3Like Nix packages, NixOS modules can declare meta-attributes to provide
4extra information. Module meta attributes are defined in the `meta.nix`
5special module.
6
7`meta` is a top level attribute like `options` and `config`. Available
8meta-attributes are `maintainers` and `doc`.
9
10Each of the meta-attributes must be defined at most once per module
11file.
12
13```nix
14{ config, lib, pkgs, ... }:
15{
16 options = {
17 ...
18 };
19
20 config = {
21 ...
22 };
23
24 meta = {
25 maintainers = with lib.maintainers; [ ericsagnes ];
26 doc = ./default.xml;
27 };
28}
29```
30
31- `maintainers` contains a list of the module maintainers.
32
33- `doc` points to a valid DocBook file containing the module
34 documentation. Its contents is automatically added to
35 [](#ch-configuration). Changes to a module documentation have to
36 be checked to not break building the NixOS manual:
37
38 ```ShellSession
39 $ nix-build nixos/release.nix -A manual.x86_64-linux
40 ```