Skip to content

Commit

Permalink
lib: Document status of deprecated.nix and move it
Browse files Browse the repository at this point in the history
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
NixOS/nixpkgs#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.
  • Loading branch information
roberth committed Apr 21, 2024
1 parent 8be479c commit 6c7a924
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
2 changes: 1 addition & 1 deletion lib/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
11 changes: 11 additions & 0 deletions lib/deprecated/README.md
Original file line number Diff line number Diff line change
@@ -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.
File renamed without changes.

0 comments on commit 6c7a924

Please sign in to comment.