From 5565f25247bc8cc5e23e363852a38c59e2e294c9 Mon Sep 17 00:00:00 2001 From: Tobias Pfeiffer Date: Sun, 5 Jan 2025 17:23:30 +0100 Subject: [PATCH] document tprof --- README.md | 7 ++++--- lib/benchee/configuration.ex | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ea585d2c..d94ae397 100644 --- a/README.md +++ b/README.md @@ -256,10 +256,11 @@ The available options are the following (also documented in [hexdocs](https://he * `profile_after` - accepts any of the following options: * a boolean - `true` will enable profiling with the default profiler (`:eprof`) and `false` will disable profiling. Defaults to `false`. * a profiler - either as a tuple of `{profiler, opts}` (e.g., `{:fprof, [sort: :own]}`) or just the profiler (e.g., `:fprof`), - which is equivalent to `{profiler, []}`. The accepted built-in profilers are + which is equivalent to `{profiler, []}`. The accepted built-in profilers are: [`:cprof`](https://hexdocs.pm/mix/Mix.Tasks.Profile.Cprof.html), - [`:eprof`](https://hexdocs.pm/mix/Mix.Tasks.Profile.Eprof.html) and - [`:fprof`](https://hexdocs.pm/mix/Mix.Tasks.Profile.Fprof.html). + [`:eprof`](https://hexdocs.pm/mix/Mix.Tasks.Profile.Eprof.html) + [`:fprof`](https://hexdocs.pm/mix/Mix.Tasks.Profile.Fprof.html) and + [`:tprof`](https://hexdocs.pm/mix/Mix.Tasks.Profile.Tprof.html) (requires elixir >= 1.17 and erlang >= 27). ### Metrics to measure diff --git a/lib/benchee/configuration.ex b/lib/benchee/configuration.ex index 3f232d09..965d1dc3 100644 --- a/lib/benchee/configuration.ex +++ b/lib/benchee/configuration.ex @@ -134,10 +134,11 @@ defmodule Benchee.Configuration do * a boolean - `true` will enable profiling with the default profiler (`:eprof`) and `false` will disable profiling. Defaults to `false`. * a profiler - either as a tuple of `{profiler, opts}` (e.g., `{:fprof, [sort: :own]}`) - or just the profiler (e.g., `:fprof`), which is equivalent to `{profiler, []}`. The accepted built-in profilers are + or just the profiler (e.g., `:fprof`), which is equivalent to `{profiler, []}`. The accepted built-in profilers are: [`:cprof`](https://hexdocs.pm/mix/Mix.Tasks.Profile.Cprof.html), - [`:eprof`](https://hexdocs.pm/mix/Mix.Tasks.Profile.Eprof.html) and - [`:fprof`](https://hexdocs.pm/mix/Mix.Tasks.Profile.Fprof.html). + [`:eprof`](https://hexdocs.pm/mix/Mix.Tasks.Profile.Eprof.html) + [`:fprof`](https://hexdocs.pm/mix/Mix.Tasks.Profile.Fprof.html) and + [`:tprof`](https://hexdocs.pm/mix/Mix.Tasks.Profile.Tprof.html) (requires elixir >= 1.17 and erlang >= 27). """ @type user_configuration :: map | keyword