b12f/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
No known key found for this signature in database
GPG key ID: 5E4C836C632C2882
1 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
nixos/doc/manual/development/meta-attributes.xml
View file

@ -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>