Merge pull request NixOS#13592 from Profpatsch/copyPathToStore-doc

lib/copyPathToStore: annotate docstring
cdyson37 · Mar 1, 2016 · bf4cafd · bf4cafd
2 parents 69237f3 + 82fa1a7
commit bf4cafd
Showing 1 changed file with 3 additions and 0 deletions.
diff --git 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.