diff options
| author | Robert Hensing <robert@roberthensing.nl> | 2024-04-21 16:03:31 +0200 |
|---|---|---|
| committer | Robert Hensing <robert@roberthensing.nl> | 2024-04-21 16:04:35 +0200 |
| commit | 33e02424d2c9165bef7799bc8ea25f8bbdfe2c1c (patch) | |
| tree | 75bb883cd88b1688c12f5edffd6fbe56a7492331 /lib/deprecated/README.md | |
| parent | 62f7c1ff246c42a8a4277bb1bea12529f357e2bb (diff) | |
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.
Diffstat (limited to 'lib/deprecated/README.md')
| -rw-r--r-- | lib/deprecated/README.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/deprecated/README.md b/lib/deprecated/README.md new file mode 100644 index 0000000000000..afeb34d449f56 --- /dev/null +++ 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. |