docs: documentation for cleanSource

NixOS · Oct 2, 2018 · 1d68b5e · 1d68b5e
1 parent 1643967
commit 1d68b5e
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/sources.nix b/lib/sources.nix
@@ -26,6 +26,10 @@ rec {
     (type == "symlink" && lib.hasPrefix "result" baseName)
   );
 
+  # Filters a source tree removing version control files and directories using cleanSourceWith
+  #
+  # Example:
+  #          cleanSource ./.
   cleanSource = src: cleanSourceWith { filter = cleanSourceFilter; inherit src; };
 
   # Like `builtins.filterSource`, except it will compose with itself,