summaryrefslogtreecommitdiff
path: root/docs/ide-support.md
diff options
context:
space:
mode:
authorCraig Hesling <hesling@chromium.org>2020-12-11 11:26:46 -0800
committerCommit Bot <commit-bot@chromium.org>2020-12-14 18:45:51 +0000
commitbce4e485bb89f1071f7c3392bf993540bd6650c0 (patch)
tree4e7f99d205ee20963c84db9f0a4294dc29ac2b69 /docs/ide-support.md
parentd76cd68529ced5e4271a2a7f4a56424b74a2c896 (diff)
downloadchrome-ec-bce4e485bb89f1071f7c3392bf993540bd6650c0.tar.gz
ide-support: Add vscode default settings.json and gitignores
This adds a .default settings.json file for vscode, so that you do not need to copy/paste form the ide-support.md doc. This also makes it easier for people that don't known that the ide-support.md doc exists. This also adds the .vscode directory to the gitignores, so that local customization/settings are not always in the git status. BRANCH=none BUG=none TEST=Checked in Gitiles TEST=Check that my settings.json is not in "git status". TEST=Check that ec.code-workspace is not in "git status". Change-Id: I4dd8cfcd79c291a6f4fb0d573df131f0cb0d9844 Signed-off-by: Craig Hesling <hesling@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2586041 Commit-Queue: Jett Rink <jettrink@chromium.org> Reviewed-by: Jett Rink <jettrink@chromium.org>
Diffstat (limited to 'docs/ide-support.md')
-rw-r--r--docs/ide-support.md41
1 files changed, 5 insertions, 36 deletions
diff --git a/docs/ide-support.md b/docs/ide-support.md
index 022373042f..cec196be58 100644
--- a/docs/ide-support.md
+++ b/docs/ide-support.md
@@ -49,40 +49,9 @@ includes selectable sub-configurations for every board/image pair.
can select a configuration by pressing `Ctrl-Shift-P` and selecting the
`C/C++ Select a Configuration...` option.
-5. Add the EC specific file associations and style settings. Modify
- `.vscode/settings.json` to have the following elements:
-
- ```json
- {
- "editor.rulers": [80],
- /* C, Makefiles, ASM, Linkerfiles, Properties */
- "editor.insertSpaces": false,
- "editor.tabSize": 8,
- /* Some exceptions based on current trends */
- "[markdown]": {
- "editor.insertSpaces": true,
- "editor.tabSize": 2
- },
- "[python]": {
- "editor.insertSpaces": true,
- "editor.tabSize": 2
- },
- "[shellscript]": {
- "editor.insertSpaces": true,
- "editor.tabSize": 2
- },
- "[yaml]": {
- "editor.insertSpaces": true,
- "editor.tabSize": 2
- },
- "files.associations": {
- "Makefile.*": "makefile",
- "*.inc": "c",
- "*.wrap": "c",
- "*.tasklist": "c",
- "*.irqlist": "c",
- "*.mocklist": "c",
- "*.testlist": "c"
- }
- }
+5. Add the EC specific file associations and style settings. Do the following
+ to copy the default settings to `.vscode/settings.json`:
+
+ ```bash
+ cp .vscode/settings.json.default .vscode/settings.json
```