From 3ad2516a97ede2b66d636e1ee7748b7f62f56dbd Mon Sep 17 00:00:00 2001 From: Gyeongjae Choi Date: Thu, 5 Nov 2026 15:02:33 +0900 Subject: [PATCH] Update docs for --in-process option --- doc/changelog.rst | 7 +++++++ doc/runner.rst | 4 ++++ 2 files changed, 11 insertions(+) diff --git a/doc/changelog.rst b/doc/changelog.rst index 066beb8f..753992cf 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -1,6 +1,13 @@ Changelog ========= +Version 2.11.0 (2026-XX-XX) +--------------------------- + +* Feature: Add ``--in-process`` option to run benchmarks in the current process. + This is useful when you cannot spawn child processes, such as on WASM environments. + Patch by Gyeongjae Choi. + Version 2.10.0 (2026-02-07) --------------------------- diff --git a/doc/runner.rst b/doc/runner.rst index 6e9dbf4c..6b5cdc58 100644 --- a/doc/runner.rst +++ b/doc/runner.rst @@ -101,6 +101,7 @@ Option:: --timeout TIMEOUT --track-memory --tracemalloc + --in-process * ``--python=PYTHON``: Python executable. By default, use the running Python (``sys.executable``). The Python executable must have the ``pyperf`` module @@ -155,6 +156,9 @@ Option:: ``/proc/self/smaps``. On Windows, get ``PeakPagefileUsage`` of ``GetProcessMemoryInfo()`` (of the current process): the peak value of the Commit Charge during the lifetime of this process. +* ``--in-process``: run the benchmark in the current process instead of a child process. + This is useful when you cannot spawn child processes, such as on WASM environments. + Note that this makes each run affect the next run, as the benchmark is executed in the same process. Internal usage only