Merge pull request #49 from JuliaLang/ct/add-warning

Add warning to `check_allocs(...)`

Author: topolarity

src/AllocCheck.jl

@@ -170,7 +170,18 @@ end
     check_allocs(func, types; ignore_throw=true)
 
 Compiles the given function and types to LLVM IR and checks for allocations.
-Returns a vector of `AllocationSite` structs, each containing a `CallInst` and a backtrace.
+
+Returns a vector of `AllocationSite`, `DynamicDispatch`, and `AllocatingRuntimeCall`
+
+!!! warning
+    The Julia language/compiler does not guarantee that this result is stable across
+    Julia invocations.
+
+    If you rely on allocation-free code for safety/correctness, it is not sufficient
+    to verify `check_allocs` in test code and expect that the corresponding call in
+    production will not allocate at runtime.
+
+    For this case, you must use `@check_allocs` instead.
 
 # Example
 ```jldoctest