summary refs log tree commit diff
path: root/lib
diff options
context:
space:
mode:
authorMatthew Bauer <mjbauer95@gmail.com>2018-10-02 16:08:27 -0500
committerGitHub <noreply@github.com>2018-10-02 16:08:27 -0500
commit8fd8d7252776066f5af5ce52c5f5c7b85181ba43 (patch)
tree9c1dcda9596239985a2d509849b114a029811a62 /lib
parenta88b8da55436e4d74ff5fa50c5c20308966a34cb (diff)
parent1d68b5ee84fb6eb35bb2afe6b824613e78dc0798 (diff)
downloadnixlib-8fd8d7252776066f5af5ce52c5f5c7b85181ba43.tar
nixlib-8fd8d7252776066f5af5ce52c5f5c7b85181ba43.tar.gz
nixlib-8fd8d7252776066f5af5ce52c5f5c7b85181ba43.tar.bz2
nixlib-8fd8d7252776066f5af5ce52c5f5c7b85181ba43.tar.lz
nixlib-8fd8d7252776066f5af5ce52c5f5c7b85181ba43.tar.xz
nixlib-8fd8d7252776066f5af5ce52c5f5c7b85181ba43.tar.zst
nixlib-8fd8d7252776066f5af5ce52c5f5c7b85181ba43.zip
Merge pull request #47681 from NixOS/docs-lib-sources
docs: documentation for `cleanSource`
Diffstat (limited to 'lib')
-rw-r--r--lib/sources.nix4
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/sources.nix b/lib/sources.nix
index 704711b20cd9..e64b23414e86 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,