diff options
| author | Ingy döt Net <ingy@ingy.net> | 2020-05-25 15:44:58 -0700 |
|---|---|---|
| committer | Ingy döt Net <ingy@ingy.net> | 2020-05-25 17:35:20 -0700 |
| commit | 2b688f41239b68e3f17e71c80a436e58dfdd5ae8 (patch) | |
| tree | fa37d3bcb3de718f9815ee76289dfeac33f65848 | |
| parent | b503ed15eaca5c222d9ba2809b1c83b8c42abeeb (diff) | |
| download | libyaml-git-2b688f41239b68e3f17e71c80a436e58dfdd5ae8.tar.gz | |
Update ReadMe with environment variable info
| -rw-r--r-- | ReadMe.md | 39 |
1 files changed, 25 insertions, 14 deletions
@@ -17,11 +17,10 @@ make test-suite # Overview This code lives in the `libyaml` git repository on the `run-test-suite` branch. -It is used to test libyaml against the YAML Test Suite. The master branch has a -Makefile rule to run this using `make test-suite`. +It is used to test libyaml against the YAML Test Suite. +The master branch has a Makefile rule to run this using `make test-suite`. -That command will checkout this branch under the `tests/run-test-suite` -directory and then call this Makefile's `make test`. +That command will checkout this branch under the `tests/run-test-suite` directory and then call this Makefile's `make test`. See: @@ -29,19 +28,31 @@ See: # Pinning -You can test older versions of master simply by checking out a version of -master and running `make test-suite`. +You can test older versions of master simply by checking out a version of master and running `make test-suite`. -The HEAD commit of your master is checked against `conf/pin.tsv`. The first row -in the tsv file whose master-commit is found in your master history is used. -This will pin to the correct yaml-test-suite commit and the correct -run-test-suite-code branch commit. +The HEAD commit of your master is checked against `conf/pin.tsv`. +The first row in the tsv file whose master-commit is found in your master history is used. +This will pin to the correct yaml-test-suite commit and the correct run-test-suite-code branch commit. -The test code and whitelists are stored in the libyaml branch -`run-test-suite-code`. +The test code and whitelists are stored in the libyaml branch `run-test-suite-code`. -NOTE: If no pinning is found, you will get a warning and the HEAD commit will -be used for the data and test code commits. +NOTE: If no pinning is found, you will get a warning and the HEAD commit will be used for the data and test code commits. + +## Pin Overrides + +You can set the following environment variables to override the pinning manually: +``` +make test \ + LIBYAML_TEST_SUITE_CODE_COMMIT=origin/run-test-suite-code \ + LIBYAML_TEST_SUITE_DATA_COMMIT=data-2020-02-11 +``` + +## Pin Debugging + +You can turn on debugging info for the pin resolver: +``` +make test LIBYAML_DEBUG_PIN=1 +``` # Test Runner Usage |