summary refs log tree commit diff
path: root/doc/contributing/coding-conventions.chapter.md
diff options
context:
space:
mode:
authorDoron Behar <doron.behar@gmail.com>2021-12-08 18:40:01 +0200
committerDoron Behar <doron.behar@gmail.com>2021-12-08 18:40:01 +0200
commit01ec4349f20157dd3bbcc1f3a540eb051c47be50 (patch)
treeaaea807cf5036c37f3caf11e72ba96090aad15a5 /doc/contributing/coding-conventions.chapter.md
parentedb8dd5e47ce8c7db77455ea4e26c969a3711406 (diff)
downloadnixpkgs-01ec4349f20157dd3bbcc1f3a540eb051c47be50.tar
nixpkgs-01ec4349f20157dd3bbcc1f3a540eb051c47be50.tar.gz
nixpkgs-01ec4349f20157dd3bbcc1f3a540eb051c47be50.tar.bz2
nixpkgs-01ec4349f20157dd3bbcc1f3a540eb051c47be50.tar.lz
nixpkgs-01ec4349f20157dd3bbcc1f3a540eb051c47be50.tar.xz
nixpkgs-01ec4349f20157dd3bbcc1f3a540eb051c47be50.tar.zst
nixpkgs-01ec4349f20157dd3bbcc1f3a540eb051c47be50.zip
docs: Make coding conventions use pname/version
Make it clear that we prefer using `pname` and `version` separated and
not the `name` attribute.
Diffstat (limited to 'doc/contributing/coding-conventions.chapter.md')
-rw-r--r--doc/contributing/coding-conventions.chapter.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/contributing/coding-conventions.chapter.md b/doc/contributing/coding-conventions.chapter.md
index 79d90c23a40..877a1743c1f 100644
--- a/doc/contributing/coding-conventions.chapter.md
+++ b/doc/contributing/coding-conventions.chapter.md
@@ -214,15 +214,15 @@ Most of the time, these are the same. For instance, the package `e2fsprogs` has
 
 There are a few naming guidelines:
 
-- The `name` attribute _should_ be identical to the upstream package name.
+- The `pname` attribute _should_ be identical to the upstream package name.
 
-- The `name` attribute _must not_ contain uppercase letters — e.g., `"mplayer-1.0rc2"` instead of `"MPlayer-1.0rc2"`.
+- The `pname` and the `version` attribute _must not_ contain uppercase letters — e.g., `"mplayer" instead of `"MPlayer"`.
 
-- The version part of the `name` attribute _must_ start with a digit (following a dash) — e.g., `"hello-0.3.1rc2"`.
+- The `version` attribute _must_ start with a digit e.g`"0.3.1rc2".
 
-- If a package is not a release but a commit from a repository, then the version part of the name _must_ be the date of that (fetched) commit. The date _must_ be in `"YYYY-MM-DD"` format. Also append `"unstable"` to the name - e.g., `"pkgname-unstable-2014-09-23"`.
+- If a package is not a release but a commit from a repository, then the `version` attribute _must_ be the date of that (fetched) commit. The date _must_ be in `"unstable-YYYY-MM-DD"` format.
 
-- Dashes in the package name _should_ be preserved in new variable names, rather than converted to underscores or camel cased — e.g., `http-parser` instead of `http_parser` or `httpParser`. The hyphenated style is preferred in all three package names.
+- Dashes in the package `pname` _should_ be preserved in new variable names, rather than converted to underscores or camel cased — e.g., `http-parser` instead of `http_parser` or `httpParser`. The hyphenated style is preferred in all three package names.
 
 - If there are multiple versions of a package, this _should_ be reflected in the variable names in `all-packages.nix`, e.g. `json-c-0-9` and `json-c-0-11`. If there is an obvious “default” version, make an attribute like `json-c = json-c-0-9;`. See also [](#sec-versioning)