diff options
| author | Robert Helgesson <robert@rycee.net> | 2017-11-14 18:59:27 +0100 |
|---|---|---|
| committer | Robert Helgesson <robert@rycee.net> | 2017-11-14 19:17:35 +0100 |
| commit | 91154416b650e7a09c44b0c0d97399bc5c849117 (patch) | |
| tree | 33ed1fe4d742e24fa6e77f142679d76c6add44ec /nixos/doc/manual/development | |
| parent | ea1724ba371ad7921323c5f07021f6ef4748258a (diff) | |
| download | nixpkgs-91154416b650e7a09c44b0c0d97399bc5c849117.tar nixpkgs-91154416b650e7a09c44b0c0d97399bc5c849117.tar.gz nixpkgs-91154416b650e7a09c44b0c0d97399bc5c849117.tar.bz2 nixpkgs-91154416b650e7a09c44b0c0d97399bc5c849117.tar.lz nixpkgs-91154416b650e7a09c44b0c0d97399bc5c849117.tar.xz nixpkgs-91154416b650e7a09c44b0c0d97399bc5c849117.tar.zst nixpkgs-91154416b650e7a09c44b0c0d97399bc5c849117.zip | |
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.
Diffstat (limited to 'nixos/doc/manual/development')
| -rw-r--r-- | nixos/doc/manual/development/option-declarations.xml | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/nixos/doc/manual/development/option-declarations.xml b/nixos/doc/manual/development/option-declarations.xml index be793152f9e..ed718c89eb7 100644 --- a/nixos/doc/manual/development/option-declarations.xml +++ b/nixos/doc/manual/development/option-declarations.xml @@ -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. |