Merge pull request #13592 from Profpatsch/copyPathToStore-doc

lib/copyPathToStore: annotate docstring
2016-03-01 08:38:07 -06:00 · 2016-03-01 08:38:07 -06:00 · bf4cafd1dd
commit bf4cafd1dd
parent 69237f371c 82fa1a796b
1 changed files with 3 additions and 0 deletions
--- a/pkgs/build-support/trivial-builders.nix
+++ b/pkgs/build-support/trivial-builders.nix
@ -157,6 +157,9 @@ rec {
      '';

  # Copy a path to the Nix store.
+  # Nix automatically copies files to the store before stringifying paths.
+  # If you need the store path of a file, ${copyPathToStore <path>} can be
+  # shortened to ${<path>}.
  copyPathToStore = builtins.filterSource (p: t: true);

  # Copy a list of paths to the Nix store.