From 9c9bf6413e50f31aee964960febccfec89900fc7 Mon Sep 17 00:00:00 2001 From: Tony Gorez Date: Mon, 22 Aug 2022 18:14:25 +0200 Subject: [PATCH 01/10] doc: enrich test command with executable --- BUILDING.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 47e2a71772f212..138bcaeaef9193 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -318,36 +318,44 @@ If you are updating tests and want to run tests in a single test file (e.g. `test/parallel/test-stream2-transform.js`): ```text -$ tools/test.py test/parallel/test-stream2-transform.js +$ tools/test.py test/parallel/test-stream2-transform.js +``` + +For example on Mac it will be: + +```text +$ python3 tools/test.py child-process ``` You can execute the entire suite of tests for a given subsystem by providing the name of a subsystem: ```text -$ tools/test.py child-process +$ tools/test.py child-process ``` You can also execute the tests in a test suite directory (such as `test/message`): ```text -$ tools/test.py test/message +$ tools/test.py test/message ``` If you want to check the other options, please refer to the help by using the `--help` option: ```text -$ tools/test.py --help +$ tools/test.py --help ``` You can usually run tests directly with node: ```text -$ ./node ./test/parallel/test-stream2-transform.js +$ ./node test/parallel/test-stream2-transform.js ``` +> Info: `./node` points to your local Node.js build. + Remember to recompile with `make -j4` in between test runs if you change code in the `lib` or `src` directories. From ac5ddd90d7df4b47f40d28cd02444e6ceb35c71d Mon Sep 17 00:00:00 2001 From: Tony Gorez Date: Tue, 23 Aug 2022 17:16:07 +0200 Subject: [PATCH 02/10] doc: use python3 as command --- BUILDING.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 138bcaeaef9193..cb98b2fb57edea 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -318,34 +318,28 @@ If you are updating tests and want to run tests in a single test file (e.g. `test/parallel/test-stream2-transform.js`): ```text -$ tools/test.py test/parallel/test-stream2-transform.js -``` - -For example on Mac it will be: +$ python3 tools/test.py test/parallel/test-stream2-transform.js -```text -$ python3 tools/test.py child-process -``` You can execute the entire suite of tests for a given subsystem by providing the name of a subsystem: ```text -$ tools/test.py child-process +$ python3 tools/test.py child-process ``` You can also execute the tests in a test suite directory (such as `test/message`): ```text -$ tools/test.py test/message +$ python3 tools/test.py test/message ``` If you want to check the other options, please refer to the help by using the `--help` option: ```text -$ tools/test.py --help +$ python3 tools/test.py --help ``` You can usually run tests directly with node: From fe37e8a94af7ac74e93681878fb48d50f7ec6506 Mon Sep 17 00:00:00 2001 From: Tony Gorez Date: Tue, 23 Aug 2022 17:29:20 +0200 Subject: [PATCH 03/10] doc: apply linter --- BUILDING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index cb98b2fb57edea..c19edd773c6b8b 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -317,7 +317,7 @@ To run the linter without running tests, use If you are updating tests and want to run tests in a single test file (e.g. `test/parallel/test-stream2-transform.js`): -```text +````text $ python3 tools/test.py test/parallel/test-stream2-transform.js @@ -326,7 +326,7 @@ by providing the name of a subsystem: ```text $ python3 tools/test.py child-process -``` +```` You can also execute the tests in a test suite directory (such as `test/message`): From e79e7689fb22da0e134e797cf8f86b6c5fa8390e Mon Sep 17 00:00:00 2001 From: Tony Gorez Date: Wed, 24 Aug 2022 07:08:29 +0200 Subject: [PATCH 04/10] doc: fix code snippet --- BUILDING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index c19edd773c6b8b..4f6e52374ad512 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -317,16 +317,16 @@ To run the linter without running tests, use If you are updating tests and want to run tests in a single test file (e.g. `test/parallel/test-stream2-transform.js`): -````text +```text $ python3 tools/test.py test/parallel/test-stream2-transform.js - +``` You can execute the entire suite of tests for a given subsystem by providing the name of a subsystem: ```text $ python3 tools/test.py child-process -```` +``` You can also execute the tests in a test suite directory (such as `test/message`): From 1fb9db35d509a2393c7d23eb6a8836b9cdb46c8f Mon Sep 17 00:00:00 2001 From: Tony Gorez Date: Wed, 24 Aug 2022 07:12:32 +0200 Subject: [PATCH 05/10] doc: add note --- BUILDING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/BUILDING.md b/BUILDING.md index 4f6e52374ad512..ca9b1c1739a4fb 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -321,6 +321,8 @@ If you are updating tests and want to run tests in a single test file $ python3 tools/test.py test/parallel/test-stream2-transform.js ``` +> Note: Using `pyhton3` alias is necessary only if you don't have a python executable on your path. + You can execute the entire suite of tests for a given subsystem by providing the name of a subsystem: From 76846de86e14e0e5f0bf564f01aebee25475096f Mon Sep 17 00:00:00 2001 From: Tony Gorez Date: Wed, 24 Aug 2022 07:22:02 +0200 Subject: [PATCH 06/10] doc: lint --- BUILDING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/BUILDING.md b/BUILDING.md index ca9b1c1739a4fb..f895bb14638e31 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -321,7 +321,8 @@ If you are updating tests and want to run tests in a single test file $ python3 tools/test.py test/parallel/test-stream2-transform.js ``` -> Note: Using `pyhton3` alias is necessary only if you don't have a python executable on your path. +> Note: Using `pyhton3` alias is necessary only if you don't have +> a python executable on your path. You can execute the entire suite of tests for a given subsystem by providing the name of a subsystem: From f946aa2e2dd0ce8d243ac80e723b4cb602579aaa Mon Sep 17 00:00:00 2001 From: Tony Gorez Date: Wed, 24 Aug 2022 18:46:20 +0200 Subject: [PATCH 07/10] doc: delete python note --- BUILDING.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index f895bb14638e31..4f6e52374ad512 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -321,9 +321,6 @@ If you are updating tests and want to run tests in a single test file $ python3 tools/test.py test/parallel/test-stream2-transform.js ``` -> Note: Using `pyhton3` alias is necessary only if you don't have -> a python executable on your path. - You can execute the entire suite of tests for a given subsystem by providing the name of a subsystem: From d6ee7d8ba7aa652f2ddc0dc8ae1d934e22656d4c Mon Sep 17 00:00:00 2001 From: Tony Gorez Date: Sat, 4 Feb 2023 12:35:00 +0100 Subject: [PATCH 08/10] doc: switch from python3 to python --- BUILDING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 4f6e52374ad512..15c2a151dbab0d 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -318,28 +318,28 @@ If you are updating tests and want to run tests in a single test file (e.g. `test/parallel/test-stream2-transform.js`): ```text -$ python3 tools/test.py test/parallel/test-stream2-transform.js +$ python tools/test.py test/parallel/test-stream2-transform.js ``` You can execute the entire suite of tests for a given subsystem by providing the name of a subsystem: ```text -$ python3 tools/test.py child-process +$ python tools/test.py child-process ``` You can also execute the tests in a test suite directory (such as `test/message`): ```text -$ python3 tools/test.py test/message +$ python tools/test.py test/message ``` If you want to check the other options, please refer to the help by using the `--help` option: ```text -$ python3 tools/test.py --help +$ python tools/test.py --help ``` You can usually run tests directly with node: From 889b81f55053ffae54581578cc2d38968220975d Mon Sep 17 00:00:00 2001 From: Tony Gorez Date: Sun, 5 Feb 2023 16:19:39 +0100 Subject: [PATCH 09/10] doc: revert "switch from python3 to python" This reverts commit d6ee7d8ba7aa652f2ddc0dc8ae1d934e22656d4c. --- BUILDING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 15c2a151dbab0d..4f6e52374ad512 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -318,28 +318,28 @@ If you are updating tests and want to run tests in a single test file (e.g. `test/parallel/test-stream2-transform.js`): ```text -$ python tools/test.py test/parallel/test-stream2-transform.js +$ python3 tools/test.py test/parallel/test-stream2-transform.js ``` You can execute the entire suite of tests for a given subsystem by providing the name of a subsystem: ```text -$ python tools/test.py child-process +$ python3 tools/test.py child-process ``` You can also execute the tests in a test suite directory (such as `test/message`): ```text -$ python tools/test.py test/message +$ python3 tools/test.py test/message ``` If you want to check the other options, please refer to the help by using the `--help` option: ```text -$ python tools/test.py --help +$ python3 tools/test.py --help ``` You can usually run tests directly with node: From 99fa16b0a06213a2abddcaff0ccd74c6c6f35b2f Mon Sep 17 00:00:00 2001 From: Tony Gorez Date: Sun, 5 Feb 2023 16:32:03 +0100 Subject: [PATCH 10/10] doc: delete python exec from command and add a note for windows --- BUILDING.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 4f6e52374ad512..d978bb15c720b3 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -318,30 +318,33 @@ If you are updating tests and want to run tests in a single test file (e.g. `test/parallel/test-stream2-transform.js`): ```text -$ python3 tools/test.py test/parallel/test-stream2-transform.js +$ tools/test.py test/parallel/test-stream2-transform.js ``` You can execute the entire suite of tests for a given subsystem by providing the name of a subsystem: ```text -$ python3 tools/test.py child-process +$ tools/test.py child-process ``` You can also execute the tests in a test suite directory (such as `test/message`): ```text -$ python3 tools/test.py test/message +$ tools/test.py test/message ``` If you want to check the other options, please refer to the help by using the `--help` option: ```text -$ python3 tools/test.py --help +$ tools/test.py --help ``` +> Note: On Windows you should use `python3` executable. +> Example: `python3 tools/test.py test/message` + You can usually run tests directly with node: ```text