diff --git a/docs/benchmarks/performance/README.md b/docs/benchmarks/performance/README.md index b6fc3b6316..c7e783c1b9 100644 --- a/docs/benchmarks/performance/README.md +++ b/docs/benchmarks/performance/README.md @@ -7,7 +7,7 @@ the on-disk and one-turn tables there came from other means, and `METHOD-REVIEW. records what is and is not documented about them. ```bash -WORKDIR=$PWD docs/benchmarks/measure-cli.sh codeaf /tmp/bench-home/codeaf ./bin/codeaf chat +WORKDIR=$PWD docs/benchmarks/performance/measure-cli.sh codeaf /tmp/bench-home/codeaf ./bin/codeaf chat ``` Run it once per CLI, on the same machine, in the same working directory, within the same diff --git a/docs/benchmarks/performance/measure-cli.sh b/docs/benchmarks/performance/measure-cli.sh index 3a26cb5688..16c6529f1f 100755 --- a/docs/benchmarks/performance/measure-cli.sh +++ b/docs/benchmarks/performance/measure-cli.sh @@ -5,7 +5,7 @@ # # From the root of a real repository: # -# WORKDIR=$PWD docs/benchmarks/measure-cli.sh mine /tmp/bench-home/mine bin/mine chat +# WORKDIR=$PWD docs/benchmarks/performance/measure-cli.sh mine /tmp/bench-home/mine bin/mine chat # # only labels the output, the tmux session and the run; nothing about the # CLI is inferred from it. is the profile the CLI runs under — an diff --git a/docs/changes/unreleased/1536-performance-benchmark-script-path.md b/docs/changes/unreleased/1536-performance-benchmark-script-path.md new file mode 100644 index 0000000000..2cc44f757a --- /dev/null +++ b/docs/changes/unreleased/1536-performance-benchmark-script-path.md @@ -0,0 +1,11 @@ +--- +kind: fixed +title: Performance benchmark examples use the script's real path +pr: 1536 +surface: [docs] +invalidates: + - "The benchmark examples pointed to docs/benchmarks/measure-cli.sh, which does not exist. The script lives under docs/benchmarks/performance/measure-cli.sh." +--- + +The performance benchmark README and the script's own usage example now resolve +the executable from the repository root.