lib.path.subpath.isValid: Add definition of a subpath

Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-07-20 22:10:39 +02:00 · 2023-07-20 22:10:39 +02:00 · d7bf0d777a
parent b42e178ed4
commit d7bf0d777a
1 changed files with 3 additions and 0 deletions
--- a/lib/path/default.nix
+++ b/lib/path/default.nix
@ -319,6 +319,9 @@ in /* No rec! Add dependencies on this file at the top. */ {

  /* Whether a value is a valid subpath string.

+  A subpath string points to a specific file or directory within an absolute base directory.
+  It is a stricter form of a relative path that excludes `..` components, since those could escape the base directory.
+
  - The value is a string

  - The string is not empty