Skip to content
Snippets Groups Projects
Commit db6c53fa authored by Raphaël Gomès's avatar Raphaël Gomès
Browse files

readme: update to reflect the new changes from packaging

parent 2d86a78d
No related branches found
No related tags found
1 merge request!22Package poulpe and add a tiny CLI wrapper for utils
......@@ -22,9 +22,9 @@
Creating a bin-env
==================
You can use `bin/bin-env-util` to create and query binary environments.
You can use `poulpe bin-env-util` to create and query binary environments.
The `setup-one` command will run a script that takes care of setting up the environment. There is currently only one script in this repository (which sets up a Mercurial repository), feel free to adapt and create your own.
Example:
```console
......@@ -26,9 +26,9 @@
The `setup-one` command will run a script that takes care of setting up the environment. There is currently only one script in this repository (which sets up a Mercurial repository), feel free to adapt and create your own.
Example:
```console
$ MERCURIAL_VERSION="6.4rc0" MERCURIAL_FLAVOR="rhg" ./bin/bin-env-util setup-one \
$ MERCURIAL_VERSION="6.4rc0" MERCURIAL_FLAVOR="rhg" poulpe bin-env-util setup-one \
$DATA_DIR/bin-envs/mercurial-6.4rc0-rhg \
suites/hg/bin-env-setup/mercurial.poulpe-setup.sh
```
......@@ -36,7 +36,7 @@
You can make sure the environment is setup correctly:
```console
$ ./bin/env-desc show $DATA_DIR/bin-envs/mercurial-6.4rc0-rhg/bin-env.poulpe
$ poulpe env-desc show $DATA_DIR/bin-envs/mercurial-6.4rc0-rhg/bin-env.poulpe
bin-env-vars:
hg:
changeset:
......@@ -60,7 +60,7 @@
You can query the environment for information:
```console
$ ./bin/env-desc get $DATA_DIR/bin-envs/mercurial-6.4rc0-rhg/bin-env.poulpe bin-env-vars.hg.changeset.node
$ poulpe env-desc get $DATA_DIR/bin-envs/mercurial-6.4rc0-rhg/bin-env.poulpe bin-env-vars.hg.changeset.node
05de4896508e8ec387b33eb30d8aab78d1c8e9e4
```
......@@ -73,8 +73,6 @@
Creating a data-env
===================
XXX You need to add `/path/to/poulpe/bin` to your `$PATH`. This will be fixed shortly.
There are a few scripts to help setting up a data environment in `suites/hg/setup-data`.
They are all specific to setting up an existing Mercurial clone, feel free to create your own.
......@@ -99,8 +97,8 @@
Running a benchmark
===================
You can use `bin/run-util` to run a benchmark. There are many benchmarks in `suites/hg/benchmarks` that are specific to benchmarking Mercurial. Feel free to create your own.
You can use `poulpe run-util` to run a benchmark. There are many benchmarks in `suites/hg/benchmarks` that are specific to benchmarking Mercurial. Feel free to create your own.
Example:
```console
......@@ -103,12 +101,12 @@
Example:
```console
$ mkdir results
$ ./bin/run-util $DATA_DIR/bin-envs/mercurial-6.4rc0-rhg $DATA_DIR/data-envs/my-repo-dirstate-v2 suites/hg/benchmarks/status.pbd $DATA_DIR/results/status-6.4rc0-rhg.pbr
$ mkdir $DATA_DIR/results
$ poulpe run-util $DATA_DIR/bin-envs/mercurial-6.4rc0-rhg $DATA_DIR/data-envs/my-repo-dirstate-v2 suites/hg/benchmarks/status.pbd $DATA_DIR/results/status-6.4rc0-rhg.pbr
```
Run more from other bin-envs, then you can then compare your results:
```console
......@@ -109,13 +107,13 @@
```
Run more from other bin-envs, then you can then compare your results:
```console
$ ./bin/diff-result $DATA_DIR/results/status-6.4rc0-rust.pbr $DATA_DIR/results/status-6.4rc0-rhg.pbr
$ poulpe diff-result $DATA_DIR/results/status-6.4rc0-rust.pbr $DATA_DIR/results/status-6.4rc0-rhg.pbr
0.0756 -> 0.0026: -0.0730 (0.03)
```
More info:
```console
......@@ -116,10 +114,10 @@
0.0756 -> 0.0026: -0.0730 (0.03)
```
More info:
```console
$ ./bin/diff-result $DATA_DIR/results/status-0.pbr $DATA_DIR/results/status-1.pbr --full
$ poulpe diff-result $DATA_DIR/results/status-0.pbr $DATA_DIR/results/status-1.pbr --full
bin-env-vars.hg.flavor: rust -> rhg
bin-env-vars.hg.version: -> 6.4rc0+hg6.ada9a0245fd7
result.time.max: 0.0815292945 -> 0.00340343696
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment