Add cautionary tale to mem_alloc description

Fixes #62 (comment)
r-lib · Oct 16, 2019 · d01e44d · d01e44d
1 parent 9168d0c
commit d01e44d
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 3 deletions.
diff --git a/R/mark.R b/R/mark.R
@@ -166,7 +166,10 @@ time_cols <- c("min", "median", "total_time")
 #'   - `mean` - `bench_time` The arithmetic mean of execution time
 #'   - `median` - `bench_time` The sample median of execution time.
 #'   - `max` - `bench_time` The maximum execution time.
-#'   - `mem_alloc` - `bench_bytes` Total amount of memory allocated by running the expression.
+#'   - `mem_alloc` - `bench_bytes` Total amount of memory allocated by R while
+#'     running the expression. Memory allocated *outside* the R heap, e.g. by
+#'     `malloc()` or `new` directly is *not* tracked, take care to avoid
+#'     misinterpreting the results if running code that may do this.
 #'   - `itr/sec` - `integer` The estimated number of executions performed per second.
 #'   - `n_itr` - `integer` Total number of iterations after filtering
 #'      garbage collections (if `filter_gc == TRUE`).

diff --git a/man/mark.Rd b/man/mark.Rd
diff --git a/man/summary.bench_mark.Rd b/man/summary.bench_mark.Rd