From e19107ebadb29dfce133c82e255b0f1cb2673758 Mon Sep 17 00:00:00 2001 From: Justin Wood Date: Wed, 1 Apr 2020 17:59:52 +0000 Subject: [PATCH] Aligning tasks & Docks --- .vscode/tasks.json | 22 +++++++++++++++++----- README.md | 6 ------ docs/README.md | 6 ++++++ docs/VSCODE_DEVELOPMENT.md | 19 +++++++++++++++++++ 4 files changed, 42 insertions(+), 11 deletions(-) diff --git a/.vscode/tasks.json b/.vscode/tasks.json index c7d4ebd9078f56..a4f8ce28fa5298 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -11,31 +11,43 @@ } }, { - "label": "Pretty", + "label": "Auto-enforce coding style", + "type": "shell", + "command": "make -f Makefile-Standalone pretty-check", + "group": "none" + }, + { + "label": "Verify coding style conformance", "type": "shell", "command": "make -f Makefile-Standalone pretty", "group": "none" }, { - "label": "Test & Check", + "label": "Run Unit and Functional Tests", "type": "shell", "command": "make -f Makefile-Standalone check", "group": "none" }, { - "label": "Dist Check", + "label": "Run Distribution Generation", "type": "shell", "command": "make -f Makefile-Standalone distcheck", "group": "none" }, { - "label": "Clean", + "label": "Run Code Coverage", + "type": "shell", + "command": "make -f Makefile-Standalone coverage", + "group": "none" + }, + { + "label": "Clean build", "type": "shell", "command": "make -f Makefile-Standalone clean", "group": "none" }, { - "label": "Bootstrap", + "label": "Bootstrap the source tree", "type": "shell", "command": "./bootstrap", "group": "none" diff --git a/README.md b/README.md index e267d8dedafcd0..3386517d961b6e 100644 --- a/README.md +++ b/README.md @@ -45,12 +45,6 @@ The CHIP repository is structured as follows: | `third_party/` | Third-party code used by CHIP.| | `tools/` | Tools needed to work with the CHIP repo, as well as develop in the repository | -# Third Party Tools - -Some tools and utilities are dependent on third party tools, such as Docker. - -[Docker](https://www.docker.com) is an excellent way to have stable build environments that don't pollute the host OS. It is also much easier to maintain stability across multiple host environments. Install stable version of [Docker Desktop](https://www.docker.com/products/docker-desktop) relevant to your native OS (MacOS or Windows). Once installed, you can run docker commands from the shell/terminal. - # Contributing We would love for you to contribute to CHIP and help make it even diff --git a/docs/README.md b/docs/README.md index 0d7a1263c2345e..f96378db329f38 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,3 +14,9 @@ * Documentation about style is documented in [the style guide](./STYLE_GUIDE.md) * Additional documentation about more specific files are in the [style folder](./style/) +## Third Party Tools + +Some tools and utilities are dependent on third party tools, such as Docker. + +[Docker](https://www.docker.com) is an excellent way to have stable build environments that don't pollute the host OS. It is also much easier to maintain stability across multiple host environments. Install stable version of [Docker Desktop](https://www.docker.com/products/docker-desktop) relevant to your native OS (MacOS or Windows). Once installed, you can run docker commands from the shell/terminal. + diff --git a/docs/VSCODE_DEVELOPMENT.md b/docs/VSCODE_DEVELOPMENT.md index cda75a158dd834..dca5995030d026 100644 --- a/docs/VSCODE_DEVELOPMENT.md +++ b/docs/VSCODE_DEVELOPMENT.md @@ -31,3 +31,22 @@ Tested on: Located in the [tasks json](../.vscode/tasks.json) file you'll find a list of tasks that can be run from the "Run Task..." command. Example tasks are "Clean", "Run Pretty Check" +Developers are encouraged to add tasks to the [tasks json](../.vscode/tasks.json) over time to make sure everyone is using the same base configuration and build. + +### Current base tasks are listed here +* Main Build - Full build and test of the tree +* Auto-enforce coding style +* Verify coding style conformance +* Run Unit and Functional Tests +* Run Distribution Generation - Build and check distribution, running all functional and unit tests +* Run Code Coverage (via 'make coverage') +* Clean build - Full clean build and test of the tree +* Bootstrap the source tree - On a clean tree, pull in the third party dependencies required +* Clean Tree - Full (and destructive) git clean of the tree + +## Launch Tasks + +Located in the [launch json](../.vscode/launch.json) file you'll find a list of build & run jobs that can be run from the "Run" tab and start a run or debug session. + +Developers are encouraged to add tasks to the [launch json](../.vscode/launch.json) over time to make sure everyone is using the same base debuging setup. +