summary refs log tree commit diff
path: root/lib/fileset
diff options
context:
space:
mode:
authorSilvan Mosberger <silvan.mosberger@tweag.io>2023-10-11 16:16:40 +0200
committerSilvan Mosberger <silvan.mosberger@tweag.io>2023-10-11 16:18:00 +0200
commit389be8db81592ce4c5519a96a459593e07eb82f7 (patch)
tree95ea366546bdf06d2fc11b707642f8e99fa71b08 /lib/fileset
parent4ecf0258149f4e197e9dea4d71ab22756ffc5ece (diff)
downloadnixpkgs-389be8db81592ce4c5519a96a459593e07eb82f7.tar
nixpkgs-389be8db81592ce4c5519a96a459593e07eb82f7.tar.gz
nixpkgs-389be8db81592ce4c5519a96a459593e07eb82f7.tar.bz2
nixpkgs-389be8db81592ce4c5519a96a459593e07eb82f7.tar.lz
nixpkgs-389be8db81592ce4c5519a96a459593e07eb82f7.tar.xz
nixpkgs-389be8db81592ce4c5519a96a459593e07eb82f7.tar.zst
nixpkgs-389be8db81592ce4c5519a96a459593e07eb82f7.zip
lib.fileset: Minor contributor doc adjustments
Co-authored-by: Robert Hensing <robert@roberthensing.nl>
Diffstat (limited to 'lib/fileset')
-rw-r--r--lib/fileset/README.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/lib/fileset/README.md b/lib/fileset/README.md
index 393cafb42e3..c439e449544 100644
--- a/lib/fileset/README.md
+++ b/lib/fileset/README.md
@@ -58,7 +58,8 @@ An attribute set with these values:
 
 - `_internalBase` (path):
   Any files outside of this path cannot influence the set of files.
-  This is always a directory.
+  This is always a directory and should be as long as possible.
+  This is used by `lib.fileset.toSource` to check that all files are under the `root` argument
 
 - `_internalBaseRoot` (path):
   The filesystem root of `_internalBase`, same as `(lib.path.splitRoot _internalBase).root`.
@@ -172,7 +173,8 @@ Arguments:
 
 ### Empty directories
 
-File sets can only represent a _set_ of local files, directories on their own are not representable.
+File sets can only represent a _set_ of local files.
+Directories on their own are not representable.
 
 Arguments:
 - (+) There does not seem to be a sensible set of combinators when directories can be represented on their own.