From 389be8db81592ce4c5519a96a459593e07eb82f7 Mon Sep 17 00:00:00 2001 From: Silvan Mosberger Date: Wed, 11 Oct 2023 16:16:40 +0200 Subject: [PATCH] lib.fileset: Minor contributor doc adjustments Co-authored-by: Robert Hensing --- lib/fileset/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/lib/fileset/README.md b/lib/fileset/README.md index 393cafb42e39..c439e449544e 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.