summary refs log tree commit diff
path: root/lib/sources.nix
diff options
context:
space:
mode:
authorTobias Pflug <tobias.pflug@holidaycheck.com>2017-10-30 18:13:16 +0100
committerRobert Hensing <robert@roberthensing.nl>2018-10-02 22:05:06 +0200
commit1d68b5ee84fb6eb35bb2afe6b824613e78dc0798 (patch)
treef3abe192cd97ee1bc24a32f0aacf9c0320c9354e /lib/sources.nix
parent1643967b8dc3d0d618a9ebc960996bf807dbbf4c (diff)
downloadnixpkgs-1d68b5ee84fb6eb35bb2afe6b824613e78dc0798.tar
nixpkgs-1d68b5ee84fb6eb35bb2afe6b824613e78dc0798.tar.gz
nixpkgs-1d68b5ee84fb6eb35bb2afe6b824613e78dc0798.tar.bz2
nixpkgs-1d68b5ee84fb6eb35bb2afe6b824613e78dc0798.tar.lz
nixpkgs-1d68b5ee84fb6eb35bb2afe6b824613e78dc0798.tar.xz
nixpkgs-1d68b5ee84fb6eb35bb2afe6b824613e78dc0798.tar.zst
nixpkgs-1d68b5ee84fb6eb35bb2afe6b824613e78dc0798.zip
docs: documentation for `cleanSource`
Diffstat (limited to 'lib/sources.nix')
-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,