Skip to content

Commit df6843b

Browse files
committed
docs: add --{local, target}-{repo, branch} / format
1 parent 6409011 commit df6843b

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

extras/profiling/README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,32 @@
11
# HTTPie Benchmarking Infrastructure
22

3-
This directory includes the benchmarks we
4-
use for testing HTTPie's speed and the infrastructure
5-
to automate this testing accross versions.
3+
This directory includes the benchmarks we use for testing HTTPie's speed and the infrastructure to automate this testing accross versions.
64

75
## Usage
86

97
Ensure the following requirements are satisfied:
8+
109
- Python 3.7+
1110
- `pyperf`
1211

1312
Then, run the `extras/benchmarks/run.py`:
13+
1414
```
1515
$ python extras/profiling/run.py
1616
```
1717

18-
Without any options, this command will initially create
19-
an isolated environment and install `httpie` from the
20-
latest commit. Then it will create a second environment
21-
with the `master` of the current repository and run the
22-
benchmarks on both of them. It will compare the results
23-
and print it as a markdown table:
18+
Without any options, this command will initially create an isolated environment and install `httpie` from the latest commit. Then it will create a
19+
second environment with the `master` of the current repository and run the benchmarks on both of them. It will compare the results and print it as a
20+
markdown table:
2421

25-
| Benchmark | master | this_branch |
26-
|----------------------------------------|:------:|:--------------------:|
22+
| Benchmark | master | this_branch |
23+
| -------------------------------------- | :----: | :------------------: |
2724
| `http --version` (startup) | 201 ms | 174 ms: 1.16x faster |
2825
| `http --offline pie.dev/get` (startup) | 200 ms | 174 ms: 1.15x faster |
29-
| Geometric mean | (ref) | 1.10x faster |
26+
| Geometric mean | (ref) | 1.10x faster |
27+
28+
If your `master` branch is not up-to-date, you can get a fresh clone by passing `--fresh` option. This way, the benchmark runner will clone the
29+
`httpie/httpie` repo from `GitHub` and use it as the baseline.
3030

31-
If your `master` branch is not up-to-date, you can get
32-
a fresh clone by passing `--fresh` option. This way,
33-
the benchmark runner will clone the `httpie/httpie` repo
34-
from `GitHub` and use it as the baseline.
31+
You can customize these branches by passing `--local-repo`/`--target-branch`, and customize the repos by passing `--local-repo`/`--target-repo` (can
32+
either take a URL or a path).

0 commit comments

Comments
 (0)