summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--lib/sources.nix4
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/sources.nix b/lib/sources.nix
index 704711b20cd..e64b23414e8 100644
--- 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,