diff options
author | Craig Hesling <hesling@chromium.org> | 2020-12-11 11:14:38 -0800 |
---|---|---|
committer | Commit Bot <commit-bot@chromium.org> | 2020-12-14 18:45:50 +0000 |
commit | d76cd68529ced5e4271a2a7f4a56424b74a2c896 (patch) | |
tree | 4875d12ef30181c5e734c646660839c4e0649e75 | |
parent | 51c9774be21984e2e4bdf5bddf7a777868c908b9 (diff) | |
download | chrome-ec-d76cd68529ced5e4271a2a7f4a56424b74a2c896.tar.gz |
docs/ide-support.md: Run mdformat
mdformat -w --compatibility docs/ide-support.md
BRANCH=none
BUG=none
TEST=Check in Gitiles
Change-Id: I5c381679bff894b48a49c7a5a20e8e5268678762
Signed-off-by: Craig Hesling <hesling@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2586040
Commit-Queue: Jett Rink <jettrink@chromium.org>
Reviewed-by: Jett Rink <jettrink@chromium.org>
-rw-r--r-- | docs/ide-support.md | 78 |
1 files changed, 42 insertions, 36 deletions
diff --git a/docs/ide-support.md b/docs/ide-support.md index e8ab342073..022373042f 100644 --- a/docs/ide-support.md +++ b/docs/ide-support.md @@ -34,49 +34,55 @@ You can use the `ide-config.sh` tool to generate a VSCode configuration that includes selectable sub-configurations for every board/image pair. 1. From the root `ec` directory, do the following: + ```bash mkdir -p .vscode ./util/ide-config.sh vscode all:RW all:RO | tee .vscode/c_cpp_properties.json ``` + 2. Open VSCode and navigate to some C source file. + 3. Run `C/C++ Reset IntelliSense Database` from the `Ctrl-Shift-P` menu + 4. Select the config in the bottom right, next to the `Select Language Mode`. You will only see this option when a C/C++ file is open. Additionally, you 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. 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" + } + } + ``` |