about summary refs log tree commit diff
path: root/src/libutil/util.hh
diff options
context:
space:
mode:
authorEelco Dolstra <e.dolstra@tudelft.nl>2004-03-27T17·58+0000
committerEelco Dolstra <e.dolstra@tudelft.nl>2004-03-27T17·58+0000
commitf8cd904e05b95c5a3ca7cf570c0503a25a2095ca (patch)
tree4bf7f5ee3405578999b72cbae0729c4c8ed4a011 /src/libutil/util.hh
parentf0f7a9f29962c55a6c2082b44c9befbd912c2f53 (diff)
* Disallow the Nix store or any of its parents from being symlinks.
  This is because the contents of these symlinks are not incorporated
  into the hashes of derivations, and could therefore cause a mismatch
  between the build system and the target system.  E.g., if
  `/nix/store' is a symlink to `/data/nix/store', then a builder could
  expand this path and store the result.  If on the target system
  `/nix/store' is not a symlink, or is a symlink that points somewhere
  else, we have a dangling pointer.

  The trigger for this change is that gcc 3.3.3 does exactly that (it
  applies realpath() to some files, such as libraries, which causes
  our impurity checker to bail out.)

  An annoying side-effect of this change is that it makes it harder to
  move the Nix store to a different file system.  On Linux, bind
  mounts can be used instead of symlink for this purpose (e.g., `mount
  -o bind /data/nix/store /nix/store').

Diffstat (limited to 'src/libutil/util.hh')
-rw-r--r--src/libutil/util.hh13
1 files changed, 8 insertions, 5 deletions
diff --git a/src/libutil/util.hh b/src/libutil/util.hh
index 54673c28c6..1b0600006a 100644
--- a/src/libutil/util.hh
+++ b/src/libutil/util.hh
@@ -60,15 +60,18 @@ extern string thisSystem;
    is also canonicalised. */
 Path absPath(Path path, Path dir = "");
 
-/* Canonicalise a path (as in realpath(3)). */
+/* Canonicalise a path by removing all `.' or `..' components and
+   double or trailing slashes. */
 Path canonPath(const Path & path);
 
-/* Return the directory part of the given path, i.e., everything
-   before the final `/'. */
+/* Return the directory part of the given canonical path, i.e.,
+   everything before the final `/'.  If the path is the root or an
+   immediate child thereof (e.g., `/foo'), this means an empty string
+   is returned. */
 Path dirOf(const Path & path);
 
-/* Return the base name of the given path, i.e., everything following
-   the final `/'. */
+/* Return the base name of the given canonical path, i.e., everything
+   following the final `/'. */
 string baseNameOf(const Path & path);
 
 /* Return true iff the given path exists. */