From 6808de76e6828bc7d274f9994730937442555653 Mon Sep 17 00:00:00 2001 From: Robin Gloster Date: Mon, 29 Aug 2016 09:34:24 +0000 Subject: [PATCH] nixos doc: module meta attribute section cleanup --- .../manual/development/meta-attributes.xml | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/nixos/doc/manual/development/meta-attributes.xml b/nixos/doc/manual/development/meta-attributes.xml index cebd16c2a9d0..de0870314dcb 100644 --- a/nixos/doc/manual/development/meta-attributes.xml +++ b/nixos/doc/manual/development/meta-attributes.xml @@ -4,20 +4,20 @@ version="5.0" xml:id="sec-meta-attributes"> -Meta-attributes +Meta Attributes -Like Nix packages, NixOS modules can declare meta-attributes to provide - extra information. Module meta-attributes are defined in the - meta.nix +Like Nix packages, NixOS modules can declare meta-attributes to provide + extra information. Module meta attributes are defined in the + meta.nix special module. -meta is a top level attribute like - options and config. Available - meta-attributes are maintainers and +meta is a top level attribute like + options and config. Available + meta-attributes are maintainers and doc. -Each of the meta-attributes must be defined at most once per module +Each of the meta-attributes must be defined at most once per module file. @@ -26,13 +26,13 @@ options = { ... }; - + config = { ... }; - + meta = { - maintainers = with lib.maintainers; [ ericsagnes ]; doc = ./default.xml; }; @@ -48,11 +48,11 @@ - doc point to a valid docbook file containing the module - documentation, its contents are automatically added to the doc points to a valid DocBook file containing the module + documentation. Its contents is automatically added to . - Changes to a module documentation must be checked to be non-breaking by - building the NixOS manual. + Changes to a module documentation have to be checked to not break + building the NixOS manual: $ nix-build nixos/release.nix -A manual