Skip to content

Commit 27222ff

Browse files
committed
Update docs
1 parent 731a4c3 commit 27222ff

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ git push origin main
4444

4545
The `bench_runner.toml` file created at the root of your repository contains configuration specific to your instance.
4646
More details about this configuration are below.
47-
Every time you make a change to the `bench_runner.toml` file, you will need to rerun `python -m bench_runer install` to have the changes reflected.
47+
Every time you make a change to the `bench_runner.toml` file, you will need to rerun `python -m bench_runner install` to have the changes reflected.
4848

4949
### Add some self-hosted runners
5050

@@ -87,6 +87,12 @@ hostname = "cpython-benchmarking-azure"
8787
available = false
8888
```
8989

90+
If you don't want a machine to be included when the user selects "machine == 'all'", add:
91+
92+
```
93+
include_in_all = false
94+
```
95+
9096
### Try a benchmarking run
9197

9298
There are instructions for running a benchmarking action already in the `README.md` of your repo. Look there and give it a try!
@@ -144,7 +150,7 @@ python -m bench_runner purge
144150

145151
To see more options that control what is deleted, run `python -m bench_runner purge --help`.
146152

147-
After purging the results, you will usually want to squash the git history down to a single commit to save space in your repository. **NOTE THAT THIS IS A DESTRUCTIVE OPERATION THAT WILL DELETE OLD DATA.**
153+
After purging the results, you will usually want to squash the git history down to a single commit to save space in your repository. **NOTE THAT THIS IS A DESTRUCTIVE OPERATION THAT WILL DELETE OLD DATA.**
148154

149155
```
150156
git checkout --orphan new-main main
@@ -155,7 +161,7 @@ git branch -M new-main main
155161
git push -f origin main
156162
```
157163

158-
### Running
164+
### Running
159165

160166
## Developer
161167

0 commit comments

Comments
 (0)