diff --git a/README.md b/README.md index b36ec8a97cfcdd91107ad7bfda04162aaf1178d1_UkVBRE1FLm1k..643d043b1d9183228f8e7adb63b3308c932a3cd3_UkVBRE1FLm1k 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,11 @@ $ pip install -e . ``` -> **Note** This guide will use `$DATA_DIR` as a shortcut for where your data (bin-envs, data-envs, results) will reside. A config file will be available shortly +> **Note** This guide will use `$DATA_DIR` as a shortcut for where your data +> (bin-envs, data-envs, results) will reside. A config file will be available +> shortly Creating a bin-env ================== You can use `poulpe bin-env-util` to create and query binary environments. @@ -21,10 +23,13 @@ Creating a bin-env ================== 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. + +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 @@ -27,8 +32,9 @@ Example: ```console -$ MERCURIAL_VERSION="6.4rc0" MERCURIAL_FLAVOR="rhg" poulpe 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 ``` @@ -60,7 +66,9 @@ You can query the environment for information: ```console -$ poulpe 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 +81,9 @@ Creating a data-env =================== -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. +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. Example: @@ -82,5 +91,6 @@ ```console $ mkdir -p $DATA_DIR/data-envs/my-repo-dirstate-v2 -$ hg clone /path/to/my-repo $DATA_DIR/data-envs/my-repo-dirstate-v2/my-repo-2023-03-09-abcdefcd-main +$ hg clone /path/to/my-repo \ + $DATA_DIR/data-envs/my-repo-dirstate-v2/my-repo-2023-03-09-abcdefcd-main [...] @@ -86,5 +96,7 @@ [...] -$ ./suites/hg/setup-data/setup-full.sh my-repo-dirstate-v2 $DATA_DIR/data-envs/my-repo-dirstate-v2 my-repo-2023-03-09-abcdefcd-main +$ ./suites/hg/setup-data/setup-full.sh my-repo-dirstate-v2 \ + $DATA_DIR/data-envs/my-repo-dirstate-v2 \ + my-repo-2023-03-09-abcdefcd-main DELETING EXISTING DATA create the base data-env creating new file: "$DATA_DIR/data-envs/my-repo-dirstate-v2/data-env.poulpe" @@ -97,9 +109,11 @@ Running a benchmark =================== -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. +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 $ mkdir $DATA_DIR/results @@ -101,12 +115,16 @@ Example: ```console $ 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 +$ 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 @@ -107,13 +125,15 @@ ``` Run more from other bin-envs, then you can then compare your results: ```console -$ poulpe 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 @@ -114,10 +134,12 @@ 0.0756 -> 0.0026: -0.0730 (0.03) ``` More info: ```console -$ poulpe 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