about summary refs log tree commit diff
path: root/pkgs/by-name/README.md
diff options
context:
space:
mode:
authorSamuel Tardieu <sam@rfc1149.net>2023-10-09 19:12:29 +0200
committerSamuel Tardieu <sam@rfc1149.net>2023-10-09 19:12:29 +0200
commit41acc25766fbc611cd10cb043bc7cab91d2fd088 (patch)
treef0733697ee2546f9abb05d6409bcd01d870230bd /pkgs/by-name/README.md
parente22c2bcad0af7f231d10ab7bbb5f95ec4f4863df (diff)
downloadnixlib-41acc25766fbc611cd10cb043bc7cab91d2fd088.tar
nixlib-41acc25766fbc611cd10cb043bc7cab91d2fd088.tar.gz
nixlib-41acc25766fbc611cd10cb043bc7cab91d2fd088.tar.bz2
nixlib-41acc25766fbc611cd10cb043bc7cab91d2fd088.tar.lz
nixlib-41acc25766fbc611cd10cb043bc7cab91d2fd088.tar.xz
nixlib-41acc25766fbc611cd10cb043bc7cab91d2fd088.tar.zst
nixlib-41acc25766fbc611cd10cb043bc7cab91d2fd088.zip
by-name: make the way of adding packages clearer
Diffstat (limited to 'pkgs/by-name/README.md')
-rw-r--r--pkgs/by-name/README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/pkgs/by-name/README.md b/pkgs/by-name/README.md
index ba1bd8cb9861..fbb8b0dc05c1 100644
--- a/pkgs/by-name/README.md
+++ b/pkgs/by-name/README.md
@@ -3,6 +3,10 @@
 The structure of this directory maps almost directly to top-level package attributes.
 This is the recommended way to add new top-level packages to Nixpkgs [when possible](#limitations).
 
+Packages found in the named-based structure do not need to be explicitly added to the
+`top-level/all-packages.nix` file unless they require overriding the default value
+of an implicit attribute (see below).
+
 ## Example
 
 The top-level package `pkgs.some-package` may be declared by setting up this file structure: