diff options
author | Robin Gloster <mail@glob.in> | 2016-08-29 09:34:24 +0000 |
---|---|---|
committer | Robin Gloster <mail@glob.in> | 2016-08-29 09:34:24 +0000 |
commit | 6808de76e6828bc7d274f9994730937442555653 (patch) | |
tree | e8ea4769be3abc03bcdb7ba5cb5078858f1f22d4 | |
parent | aca4801f533a6b8b7a7a298c874e26102254d7f3 (diff) | |
download | nixpkgs-6808de76e6828bc7d274f9994730937442555653.tar nixpkgs-6808de76e6828bc7d274f9994730937442555653.tar.gz nixpkgs-6808de76e6828bc7d274f9994730937442555653.tar.bz2 nixpkgs-6808de76e6828bc7d274f9994730937442555653.tar.lz nixpkgs-6808de76e6828bc7d274f9994730937442555653.tar.xz nixpkgs-6808de76e6828bc7d274f9994730937442555653.tar.zst nixpkgs-6808de76e6828bc7d274f9994730937442555653.zip |
nixos doc: module meta attribute section cleanup
-rw-r--r-- | nixos/doc/manual/development/meta-attributes.xml | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/nixos/doc/manual/development/meta-attributes.xml b/nixos/doc/manual/development/meta-attributes.xml index cebd16c2a9d..de0870314dc 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"> -<title>Meta-attributes</title> +<title>Meta Attributes</title> -<para>Like Nix packages, NixOS modules can declare meta-attributes to provide - extra information. Module meta-attributes are defined in the - <filename - xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/misc/meta.nix">meta.nix</filename> +<para>Like Nix packages, NixOS modules can declare meta-attributes to provide + extra information. Module meta attributes are defined in the + <filename + xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/misc/meta.nix">meta.nix</filename> special module.</para> -<para><literal>meta</literal> is a top level attribute like - <literal>options</literal> and <literal>config</literal>. Available - meta-attributes are <literal>maintainers</literal> and +<para><literal>meta</literal> is a top level attribute like + <literal>options</literal> and <literal>config</literal>. Available + meta-attributes are <literal>maintainers</literal> and <literal>doc</literal>.</para> -<para>Each of the meta-attributes must be defined at most once per module +<para>Each of the meta-attributes must be defined at most once per module file.</para> <programlisting> @@ -26,13 +26,13 @@ options = { ... }; - + config = { ... }; - + meta = { - maintainers = with lib.maintainers; [ ericsagnes ]; <co + maintainers = with lib.maintainers; [ ericsagnes ]; <co xml:id='modules-meta-1' /> doc = ./default.xml; <co xml:id='modules-meta-2' /> }; @@ -48,11 +48,11 @@ <callout arearefs='modules-meta-2'> <para> - <varname>doc</varname> point to a valid docbook file containing the module - documentation, its contents are automatically added to the <xref + <varname>doc</varname> points to a valid DocBook file containing the module + documentation. Its contents is automatically added to <xref linkend="ch-configuration"/>. - 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: </para> <programlisting>$ nix-build nixos/release.nix -A manual</programlisting> </callout> |