summary refs log tree commit diff
path: root/nixos/doc/manual/development/meta-attributes.xml
diff options
context:
space:
mode:
authorGraham Christensen <graham@grahamc.com>2018-05-01 19:57:09 -0400
committerGraham Christensen <graham@grahamc.com>2018-05-01 19:57:09 -0400
commiteca5c99bf8a115ffd9513f91decc064a5bb3ff6d (patch)
tree7b49bc123be12ca5344428c6975e4487e69d55e3 /nixos/doc/manual/development/meta-attributes.xml
parent77161de4546697f9bf2da6d081eeba4c399b3313 (diff)
downloadnixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar.gz
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar.bz2
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar.lz
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar.xz
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar.zst
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.zip
nixos docs: format =)
Diffstat (limited to 'nixos/doc/manual/development/meta-attributes.xml')
-rw-r--r--nixos/doc/manual/development/meta-attributes.xml55
1 files changed, 28 insertions, 27 deletions
diff --git a/nixos/doc/manual/development/meta-attributes.xml b/nixos/doc/manual/development/meta-attributes.xml
index de0870314dc..3d019a4987e 100644
--- a/nixos/doc/manual/development/meta-attributes.xml
+++ b/nixos/doc/manual/development/meta-attributes.xml
@@ -3,22 +3,26 @@
         xmlns:xi="http://www.w3.org/2001/XInclude"
         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
+ <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>
+  special module.
+ </para>
 
-<para><literal>meta</literal> is a top level attribute like
+ <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>
+  <literal>doc</literal>.
+ </para>
 
-<para>Each of the meta-attributes must be defined at most once per module
-  file.</para>
+ <para>
+  Each of the meta-attributes must be defined at most once per module file.
+ </para>
 
 <programlisting>
 { config, lib, pkgs, ... }:
@@ -39,24 +43,21 @@
 }
 </programlisting>
 
-<calloutlist>
- <callout arearefs='modules-meta-1'>
-  <para>
+ <calloutlist>
+  <callout arearefs='modules-meta-1'>
+   <para>
     <varname>maintainers</varname> contains a list of the module maintainers.
-  </para>
- </callout>
-
- <callout arearefs='modules-meta-2'>
-  <para>
+   </para>
+  </callout>
+  <callout arearefs='modules-meta-2'>
+   <para>
     <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 have to be checked to not break
-    building the NixOS manual:
-  </para>
-  <programlisting>$ nix-build nixos/release.nix -A manual</programlisting>
- </callout>
-
-</calloutlist>
-
+    documentation. Its contents is automatically added to
+    <xref
+      linkend="ch-configuration"/>. 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>
+ </calloutlist>
 </section>