Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/benchmarks/performance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/benchmarks/performance/measure-cli.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
#
# <name> only labels the output, the tmux session and the run; nothing about the
# CLI is inferred from it. <home> is the profile the CLI runs under — an
Expand Down
11 changes: 11 additions & 0 deletions docs/changes/unreleased/1536-performance-benchmark-script-path.md
Original file line number Diff line number Diff line change
@@ -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.