summaryrefslogtreecommitdiffstats
path: root/src/tools/clippy/src/docs/mem_forget.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/tools/clippy/src/docs/mem_forget.txt')
-rw-r--r--src/tools/clippy/src/docs/mem_forget.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/tools/clippy/src/docs/mem_forget.txt b/src/tools/clippy/src/docs/mem_forget.txt
new file mode 100644
index 000000000..a6888c48f
--- /dev/null
+++ b/src/tools/clippy/src/docs/mem_forget.txt
@@ -0,0 +1,12 @@
+### What it does
+Checks for usage of `std::mem::forget(t)` where `t` is
+`Drop`.
+
+### Why is this bad?
+`std::mem::forget(t)` prevents `t` from running its
+destructor, possibly causing leaks.
+
+### Example
+```
+mem::forget(Rc::new(55))
+``` \ No newline at end of file