From 616f35f7f8783c133f67e2eedc6adbf2d26a7e47 Mon Sep 17 00:00:00 2001 From: Damien George Date: Wed, 10 Sep 2025 16:30:57 +1000 Subject: [PATCH] tests/README: Update docs for run-perfbench.py now that it uses -t. Follow up to dbbc7d96672bb44a04f27fef32231dd7340d7952 Signed-off-by: Damien George --- tests/README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/tests/README.md b/tests/README.md index 21e14eee5e..6a6395c39c 100644 --- a/tests/README.md +++ b/tests/README.md @@ -67,16 +67,14 @@ for a full list of command line options. ### Benchmarking a target -To run tests on a firmware target using `pyboard.py`, run the command line like +To run tests on a firmware target using a serial port, run the command line like this: ``` -./run-perfbench.py -p -d /dev/ttyACM0 168 100 +./run-perfbench.py -t /dev/ttyACM0 168 100 ``` -* `-p` indicates running on a remote target via pyboard.py, not the host. -* `-d PORTNAME` is the serial port, `/dev/ttyACM0` is the default if not - provided. +* `-t PORTNAME` is the serial port to use (and it supports shorthand like `a0`). * `168` is value `N`, the approximate CPU frequency in MHz (in this case Pyboard V1.1 is 168MHz). It's possible to choose other values as well: lower values like `10` will run much the tests much quicker, higher values like `1000` will @@ -136,11 +134,11 @@ Usually you want to know if something is faster or slower than a reference. To do this, copy the output of each `run-perfbench.py` run to a text file. This can be done multiple ways, but one way on Linux/macOS is with the `tee` -utility: `./run-perfbench.py -p 168 100 | tee pyb-run1.txt` +utility: `./run-perfbench.py -t a0 168 100 | tee pyb-run1.txt` Once you have two files with output from two different runs (maybe with different code or configuration), compare the runtimes with `./run-perfbench.py --t pybv-run1.txt pybv-run2.txt` or compare scores with `./run-perfbench.py -s +-m pybv-run1.txt pybv-run2.txt` or compare scores with `./run-perfbench.py -s pybv-run1.txt pybv-run2.txt`: ```