docs: clarify package and module option naming

This attempts to briefly clarify the current naming conventions of
attribute names in `all-packages.nix` and module option names.
This commit is contained in:
Robert Helgesson
2017-11-14 19:17:35 +01:00
parent ea1724ba37
commit 91154416b6
2 changed files with 22 additions and 12 deletions
@@ -22,6 +22,15 @@ options = {
};
</programlisting>
The attribute names within the <replaceable>name</replaceable>
attribute path must be camel cased in general but should, as an
exception, match the
<link
xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming">
package attribute name</link> when referencing a Nixpkgs package. For
example, the option <varname>services.nix-serve.bindAddress</varname>
references the <varname>nix-serve</varname> Nixpkgs package.
</para>
<para>The function <varname>mkOption</varname> accepts the following arguments.