about summary refs log tree commit diff
path: root/lib/deprecated/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/deprecated/README.md')
-rw-r--r--lib/deprecated/README.md11
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.