lib: Document status of deprecated.nix and move it
This is all I could find after co-maintaining lib for a long time. I've had the fortune of basically not really noticing this file, because it has had very few interactions until the confusion in https://github.com/NixOS/nixpkgs/pull/304277 It seems to be a state of limbo, which would be nice to resolve (with great care), but this is not urgent, and first we should document its status.
This commit is contained in:
parent
62f7c1ff24
commit
33e02424d2
3 changed files with 12 additions and 1 deletions
|
@ -47,7 +47,7 @@ let
|
||||||
# misc
|
# misc
|
||||||
asserts = callLibs ./asserts.nix;
|
asserts = callLibs ./asserts.nix;
|
||||||
debug = callLibs ./debug.nix;
|
debug = callLibs ./debug.nix;
|
||||||
misc = callLibs ./deprecated.nix;
|
misc = callLibs ./deprecated/misc.nix;
|
||||||
|
|
||||||
# domain-specific
|
# domain-specific
|
||||||
fetchers = callLibs ./fetchers.nix;
|
fetchers = callLibs ./fetchers.nix;
|
||||||
|
|
11
lib/deprecated/README.md
Normal file
11
lib/deprecated/README.md
Normal file
|
@ -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.
|
Loading…
Reference in a new issue