diff options
| author | Yegor Timoshenko <yegortimoshenko@gmail.com> | 2017-12-23 17:12:29 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-12-23 17:12:29 +0300 |
| commit | 108f76c9277d68cbf6a4e814a6667a6609671949 (patch) | |
| tree | 2b360ec3558dea75096c7ff5258f4efc6b93df8f /nixos/doc/manual/development | |
| parent | da5f6aa6baa08d0dcbb59e8dd577f8de65a932a7 (diff) | |
| parent | 91154416b650e7a09c44b0c0d97399bc5c849117 (diff) | |
| download | nixpkgs-108f76c9277d68cbf6a4e814a6667a6609671949.tar nixpkgs-108f76c9277d68cbf6a4e814a6667a6609671949.tar.gz nixpkgs-108f76c9277d68cbf6a4e814a6667a6609671949.tar.bz2 nixpkgs-108f76c9277d68cbf6a4e814a6667a6609671949.tar.lz nixpkgs-108f76c9277d68cbf6a4e814a6667a6609671949.tar.xz nixpkgs-108f76c9277d68cbf6a4e814a6667a6609671949.tar.zst nixpkgs-108f76c9277d68cbf6a4e814a6667a6609671949.zip | |
Merge pull request #31668 from rycee/doc/naming
docs: clarify package and module option naming
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. |