pkgs/misc/misc.nix: document the fact that 'collection' does not detect file collisions

svn path=/nixpkgs/trunk/; revision=28610

1 files changed, 13 insertions, 11 deletions

diff --git a/pkgs/misc/misc.nix b/pkgs/misc/misc.nix
index a0b13751f717c..85959f66a7fe4 100644
--- a/pkgs/misc/misc.nix
+++ b/pkgs/misc/misc.nix
@@ -6,18 +6,20 @@ in
 
 {
 
-  /* 
-
-    usage example creating a derivation installing ruby, sup and a lib:
-
-    packageOverrides = {
-      rubyCollection = collection {
-        name = "ruby";
-        list = let l = rubyLibs; in 
-          [ pkgs.ruby l.chronic l.sup ];
-      };
-    }
+  /*
+    Usage example creating a derivation installing ruby, sup and a lib:
+
+      packageOverrides = {
+	rubyCollection = collection {
+	  name = "ruby";
+	  list = let l = rubyLibs; in
+	    [ pkgs.ruby l.chronic l.sup ];
+	};
+      }
 
+    Warning: Using this function, it is possible to install packages
+    into one profile that have file collisions, and these will not be
+    detected.
   */
   collection = {list, name} : runCommand "collection-${name}" {} ''
     mkdir -p $out/nix-support