about summary refs log tree commit diff
path: root/src/docs/inline_always.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/docs/inline_always.txt')
-rw-r--r--src/docs/inline_always.txt23
1 files changed, 0 insertions, 23 deletions
diff --git a/src/docs/inline_always.txt b/src/docs/inline_always.txt
deleted file mode 100644
index 7721da4c4cc..00000000000
--- a/src/docs/inline_always.txt
+++ /dev/null
@@ -1,23 +0,0 @@
-### What it does
-Checks for items annotated with `#[inline(always)]`,
-unless the annotated function is empty or simply panics.
-
-### Why is this bad?
-While there are valid uses of this annotation (and once
-you know when to use it, by all means `allow` this lint), it's a common
-newbie-mistake to pepper one's code with it.
-
-As a rule of thumb, before slapping `#[inline(always)]` on a function,
-measure if that additional function call really affects your runtime profile
-sufficiently to make up for the increase in compile time.
-
-### Known problems
-False positives, big time. This lint is meant to be
-deactivated by everyone doing serious performance work. This means having
-done the measurement.
-
-### Example
-```
-#[inline(always)]
-fn not_quite_hot_code(..) { ... }
-```
\ No newline at end of file