Merge pull request #305752 from hercules-ci/lib-deprecated-what

lib: Document status of deprecated.nix and move it
NixOS · Apr 22, 2024 · 3d56b38 · 3d56b38
2 parents 1e1dc66 + 33e0242
commit 3d56b38
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/lib/default.nix b/lib/default.nix
@@ -47,7 +47,7 @@ let
     # misc
     asserts = callLibs ./asserts.nix;
     debug = callLibs ./debug.nix;
-    misc = callLibs ./deprecated.nix;
+    misc = callLibs ./deprecated/misc.nix;
 
     # domain-specific
     fetchers = callLibs ./fetchers.nix;

diff --git a/lib/deprecated/README.md b/lib/deprecated/README.md
@@ -0,0 +1,11 @@
+
+# lib/deprecated
+
+Do not add any new functions to this directory.
+
+This directory contains the `lib.misc` sublibrary, which - as a location - is deprecated.
+Furthermore, some of the functions inside are of *dubious* utility, and should perhaps be avoided,
+while some functions *may still be needed*.
+
+This directory does not play a role in the deprecation process for library functions.
+They should be deprecated in place, by putting a `lib.warn` or `lib.warnIf` call around the function.
diff --git a/lib/deprecated.nix → lib/deprecated/misc.nix b/lib/deprecated.nix → lib/deprecated/misc.nix