public/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nixos doc: module meta attribute section cleanup

Browse Source
This commit is contained in:
Robin Gloster
2016-08-29 09:34:24 +00:00
parent aca4801f53
commit 6808de76e6
1 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
nixos/doc/manual/development/meta-attributes.xml
+6 -6
View File
@@ -4,10 +4,10 @@
version="5.0" version="5.0"
xml:id="sec-meta-attributes"> 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 <para>Like Nix packages, NixOS modules can declare meta-attributes to provide
extra information. Module meta-attributes are defined in the extra information. Module meta attributes are defined in the
<filename <filename
xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/misc/meta.nix">meta.nix</filename> xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/misc/meta.nix">meta.nix</filename>
special module.</para> special module.</para>
@@ -48,11 +48,11 @@
<callout arearefs='modules-meta-2'> <callout arearefs='modules-meta-2'>
<para> <para>
<varname>doc</varname> point to a valid docbook file containing the module <varname>doc</varname> points to a valid DocBook file containing the module
documentation, its contents are automatically added to the <xref documentation. Its contents is automatically added to <xref
linkend="ch-configuration"/>. linkend="ch-configuration"/>.
Changes to a module documentation must be checked to be non-breaking by Changes to a module documentation have to be checked to not break
building the NixOS manual. building the NixOS manual:
</para> </para>
<programlisting>$ nix-build nixos/release.nix -A manual</programlisting> <programlisting>$ nix-build nixos/release.nix -A manual</programlisting>
</callout> </callout>