From a7923aaaf1640ef84e46179a2c4f8f9cf9c074bb Mon Sep 17 00:00:00 2001 From: Diosney Sarmiento Date: Mon, 4 Jul 2016 12:42:20 -0400 Subject: [PATCH 1/6] docs: Added information on how to run the linter. --- BUILDING.md | 6 ++++++ CONTRIBUTING.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/BUILDING.md b/BUILDING.md index 532c478bbb736b..693a98db40594e 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -50,6 +50,12 @@ To run the tests: $ make test ``` +To run the linter: + +```text +$ make lint +``` + To run the native module tests: ```text diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 57a30b12210ae1..bb0cde8e7d940e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -150,6 +150,12 @@ $ ./configure && make -j8 test Make sure the linter is happy and that all tests pass. Please, do not submit patches that fail either check. +You can check if the linter is happy by running: + +```text +$ make lint +``` + If you are updating tests and just want to run a single test to check it, you can use this syntax to run it exactly as the test harness would: From 390101b011d90e3902884c1c974b57f77f048eeb Mon Sep 17 00:00:00 2001 From: Diosney Sarmiento Date: Mon, 4 Jul 2016 14:08:31 -0400 Subject: [PATCH 2/6] docs: Added clarification about the linter. --- BUILDING.md | 2 +- CONTRIBUTING.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 693a98db40594e..cd578d01b5e3b5 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -50,7 +50,7 @@ To run the tests: $ make test ``` -To run the linter: +To run only the linter (it will also run as part of `make test`): ```text $ make lint diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bb0cde8e7d940e..d1eb0d9f62ddb1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -150,7 +150,8 @@ $ ./configure && make -j8 test Make sure the linter is happy and that all tests pass. Please, do not submit patches that fail either check. -You can check if the linter is happy by running: +The linter will be run as part of `make test`, but you can test it directly +by running: ```text $ make lint From d85a388175e3d4a1958ec1df9981ad4e0ac34578 Mon Sep 17 00:00:00 2001 From: Diosney Sarmiento Date: Tue, 5 Jul 2016 10:40:07 -0400 Subject: [PATCH 3/6] docs: Added clarification about the linter execution. --- BUILDING.md | 6 ------ CONTRIBUTING.md | 4 ++-- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index cd578d01b5e3b5..532c478bbb736b 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -50,12 +50,6 @@ To run the tests: $ make test ``` -To run only the linter (it will also run as part of `make test`): - -```text -$ make lint -``` - To run the native module tests: ```text diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d1eb0d9f62ddb1..add6185c141716 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -150,8 +150,8 @@ $ ./configure && make -j8 test Make sure the linter is happy and that all tests pass. Please, do not submit patches that fail either check. -The linter will be run as part of `make test`, but you can test it directly -by running: +The linter will be run as part of `make test`, but it won't if any tests failed. +However you can run it directly by executing: ```text $ make lint From 50e5745f6f797c57eeb6a1b488284f4e281f7073 Mon Sep 17 00:00:00 2001 From: Diosney Sarmiento Date: Tue, 5 Jul 2016 10:50:12 -0400 Subject: [PATCH 4/6] docs: Linter line rewording. --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index add6185c141716..b7c93f7a8e68b4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -151,7 +151,7 @@ Make sure the linter is happy and that all tests pass. Please, do not submit patches that fail either check. The linter will be run as part of `make test`, but it won't if any tests failed. -However you can run it directly by executing: +If you need to run it directly despite the failing tests, you can execute: ```text $ make lint From 2f42d83fafa134403f7e0d46a4f712a39d39b3cd Mon Sep 17 00:00:00 2001 From: Diosney Sarmiento Date: Tue, 5 Jul 2016 16:58:23 -0400 Subject: [PATCH 5/6] docs: Changed for consistent verb tense. --- CONTRIBUTING.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b7c93f7a8e68b4..9b867a902bc05f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -150,12 +150,8 @@ $ ./configure && make -j8 test Make sure the linter is happy and that all tests pass. Please, do not submit patches that fail either check. -The linter will be run as part of `make test`, but it won't if any tests failed. -If you need to run it directly despite the failing tests, you can execute: - -```text -$ make lint -``` +Running `make test` will run the linter as well unless one or more tests fail. +If you want to run the linter without running tests, you can use `make lint`. If you are updating tests and just want to run a single test to check it, you can use this syntax to run it exactly as the test harness would: From 6a6189144ea8472da15ca7238f321a748db19a39 Mon Sep 17 00:00:00 2001 From: Diosney Sarmiento Date: Wed, 6 Jul 2016 07:23:48 -0400 Subject: [PATCH 6/6] repl: Fixed post-final nit in`completer` function doc. --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9b867a902bc05f..50db95b3de9537 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -151,7 +151,7 @@ Make sure the linter is happy and that all tests pass. Please, do not submit patches that fail either check. Running `make test` will run the linter as well unless one or more tests fail. -If you want to run the linter without running tests, you can use `make lint`. +If you want to run the linter without running tests, use `make lint`. If you are updating tests and just want to run a single test to check it, you can use this syntax to run it exactly as the test harness would: