populate file: deprecated exclude option

README.md

@@ -150,18 +150,13 @@ Supported attributes:
   whether a file has changed.  This is useful when `path` points at files
   with mangled timestamps, e.g. the Nix store.
 
-* `exclude` (optional)
-  List of patterns that should excluded from being synced. The list will be
-  passed to the `--exclude` option of [`rsync`](https://rsync.samba.org/).
-  Checkout the filter rules section in the [rsync
-  manual](https://download.samba.org/pub/rsync/rsync.html) for further
-  information.
-
 * `filters` (optional)
-  List of filters that should be passed to rsync. Filters are specified as
+  List of filters that should be passed to [`rsync`](https://rsync.samba.org/).
-  attribute sets with the attributes `type` and `pattern`. Supported filter
+  Filters are specified as attribute sets with the attributes `type` and
-  types are `include` and `exclude`. This allows for more advanced
+  `pattern`.  Supported filter types are `include` and `exclude`.
-  configurations.
+  Checkout the filter rules section in the
+  [rsync manual](https://download.samba.org/pub/rsync/rsync.html)
+  for further information.
 
 * `deleteExcluded` (optional)
   boolean that controls whether the excluded directories should be deleted

lib/types/populate.nix

@@ -84,6 +84,16 @@
           type = lib.types.bool;
         };
         exclude = lib.mkOption {
+          apply = x:
+            if x != [] then
+              lib.warn
+                "file.*.exclude is deprecated in favor of file.*.filters"
+                x
+            else
+              x;
+          description = ''
+            DEPRECATED, use `filters`.
+          '';
           type = lib.types.listOf lib.types.str;
           default = [];
           example = [".git"];