diff options
author | Sandro Jäckel <sandro.jaeckel@gmail.com> | 2023-02-07 20:40:26 +0100 |
---|---|---|
committer | Sandro Jäckel <sandro.jaeckel@gmail.com> | 2023-02-07 20:40:26 +0100 |
commit | fcfa4dd73bd84a038527a66c8e0a9d15c2af61fd (patch) | |
tree | ff91a6a1fd931e06df42ac1c9e86674370544e9f | |
parent | 74673fc73ff6659caf7dacf8a190833645924576 (diff) |
doc/contributing: remove last references to name
pname+version should be used everywhere, so lets clean this up
-rw-r--r-- | doc/contributing/coding-conventions.chapter.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/contributing/coding-conventions.chapter.md b/doc/contributing/coding-conventions.chapter.md index f6a0970165f56..2530b14a2f7be 100644 --- a/doc/contributing/coding-conventions.chapter.md +++ b/doc/contributing/coding-conventions.chapter.md @@ -204,13 +204,13 @@ The key words _must_, _must not_, _required_, _shall_, _shall not_, _should_, _s In Nixpkgs, there are generally three different names associated with a package: -- The `name` attribute of the derivation (excluding the version part). This is what most users see, in particular when using `nix-env`. +- The `pname` attribute of the derivation. This is what most users see, in particular when using `nix-env`. - The variable name used for the instantiated package in `all-packages.nix`, and when passing it as a dependency to other functions. Typically this is called the _package attribute name_. This is what Nix expression authors see. It can also be used when installing using `nix-env -iA`. - The filename for (the directory containing) the Nix expression. -Most of the time, these are the same. For instance, the package `e2fsprogs` has a `name` attribute `"e2fsprogs-version"`, is bound to the variable name `e2fsprogs` in `all-packages.nix`, and the Nix expression is in `pkgs/os-specific/linux/e2fsprogs/default.nix`. +Most of the time, these are the same. For instance, the package `e2fsprogs` has a `pname` attribute `"e2fsprogs"`, is bound to the variable name `e2fsprogs` in `all-packages.nix`, and the Nix expression is in `pkgs/os-specific/linux/e2fsprogs/default.nix`. There are a few naming guidelines: |