From 82fa1a796b1e8be27e5c02bc00c6cdba06b26693 Mon Sep 17 00:00:00 2001
From: Profpatsch <mail@profpatsch.de>
Date: Tue, 1 Mar 2016 15:26:01 +0100
Subject: [PATCH] lib/copyPathToStore: annotate docstring

---
 pkgs/build-support/trivial-builders.nix | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/pkgs/build-support/trivial-builders.nix b/pkgs/build-support/trivial-builders.nix
index 6cd82adf8e70..93b8b1cbc428 100644
--- 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.