diff options
author | Jack Rosenthal <jrosenth@chromium.org> | 2021-11-04 12:11:58 -0600 |
---|---|---|
committer | Commit Bot <commit-bot@chromium.org> | 2021-11-05 04:22:34 +0000 |
commit | 252457d4b21f46889eebad61d4c0a65331919cec (patch) | |
tree | 01856c4d31d710b20e85a74c8d7b5836e35c3b98 /docs/ide-support.md | |
parent | 08f5a1e6fc2c9467230444ac9b582dcf4d9f0068 (diff) | |
download | chrome-ec-stabilize-14526.73.B-ish.tar.gz |
ish: Trim down the release branchstabilize-wristpin-14469.59.B-ishstabilize-voshyr-14637.B-ishstabilize-quickfix-14695.187.B-ishstabilize-quickfix-14695.124.B-ishstabilize-quickfix-14526.91.B-ishstabilize-14695.85.B-ishstabilize-14695.107.B-ishstabilize-14682.B-ishstabilize-14633.B-ishstabilize-14616.B-ishstabilize-14589.B-ishstabilize-14588.98.B-ishstabilize-14588.14.B-ishstabilize-14588.123.B-ishstabilize-14536.B-ishstabilize-14532.B-ishstabilize-14528.B-ishstabilize-14526.89.B-ishstabilize-14526.84.B-ishstabilize-14526.73.B-ishstabilize-14526.67.B-ishstabilize-14526.57.B-ishstabilize-14498.B-ishstabilize-14496.B-ishstabilize-14477.B-ishstabilize-14469.9.B-ishstabilize-14469.8.B-ishstabilize-14469.58.B-ishstabilize-14469.41.B-ishstabilize-14442.B-ishstabilize-14438.B-ishstabilize-14411.B-ishstabilize-14396.B-ishstabilize-14395.B-ishstabilize-14388.62.B-ishstabilize-14388.61.B-ishstabilize-14388.52.B-ishstabilize-14385.B-ishstabilize-14345.B-ishstabilize-14336.B-ishstabilize-14333.B-ishrelease-R99-14469.B-ishrelease-R98-14388.B-ishrelease-R102-14695.B-ishrelease-R101-14588.B-ishrelease-R100-14526.B-ishfirmware-cherry-14454.B-ishfirmware-brya-14505.B-ishfirmware-brya-14505.71.B-ishfactory-kukui-14374.B-ishfactory-guybrush-14600.B-ishfactory-cherry-14455.B-ishfactory-brya-14517.B-ish
In the interest of making long-term branch maintenance incur as little
technical debt on us as possible, we should not maintain any files on
the branch we are not actually using.
This has the added effect of making it extremely clear when merging CLs
from the main branch when changes have the possibility to affect us.
The follow-on CL adds a convenience script to actually pull updates from
the main branch and generate a CL for the update.
BUG=b:204206272
BRANCH=ish
TEST=make BOARD=arcada_ish && make BOARD=drallion_ish
Signed-off-by: Jack Rosenthal <jrosenth@chromium.org>
Change-Id: I17e4694c38219b5a0823e0a3e55a28d1348f4b18
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3262038
Reviewed-by: Jett Rink <jettrink@chromium.org>
Reviewed-by: Tom Hughes <tomhughes@chromium.org>
Diffstat (limited to 'docs/ide-support.md')
-rw-r--r-- | docs/ide-support.md | 57 |
1 files changed, 0 insertions, 57 deletions
diff --git a/docs/ide-support.md b/docs/ide-support.md deleted file mode 100644 index cec196be58..0000000000 --- a/docs/ide-support.md +++ /dev/null @@ -1,57 +0,0 @@ -# IDE Support - -[TOC] - -## Odd File Types - -EC uses a few odd file types/names. Some are included from other header files -and used to generate data structures, thus it is important for your IDE to index -them. - -Patterns | Vague Type ------------------------------------------------------ | ---------- -`README.*` | Text -`Makefile.rules`, `Makefile.toolchain` | Makefile -`gpio.wrap` | C Header -`gpio.inc` | C Header -`*.tasklist`, `*.irqlist`, `*.mocklist`, `*.testlist` | C Header - -## IDE Configuration Primitives - -Due to the way most EC code has been structured, you can typically only safely -inspect a configuration for a single image (RO or RW) for a single board. Thus, -you need to specify the specific board/image pair when requesting defines and -includes. - -Command | Description --------------------------------------------- | ------------------------------ -`make print-defines BOARD=$BOARD BLD=RW/RO` | List compiler injected defines -`make print-includes BOARD=$BOARD BLD=RW/RO` | List compiler include paths - -## VSCode - -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. Do the following - to copy the default settings to `.vscode/settings.json`: - - ```bash - cp .vscode/settings.json.default .vscode/settings.json - ``` |