Commit 33e02424 authored by Robert Hensing's avatar Robert Hensing
Browse files

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.
parent 62f7c1ff

lib/default.nix

+1 −1
Original line number Diff line number Diff line
@@ -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;

lib/deprecated/README.md

0 → 100644
+11 −0
Original line number Diff line number Diff line 


# 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.

lib/deprecated.nix→lib/deprecated/misc.nix

+0 −0

File moved.

View file