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/configuration/template.md | |
parent | 08f5a1e6fc2c9467230444ac9b582dcf4d9f0068 (diff) | |
download | chrome-ec-release-R101-14588.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/configuration/template.md')
-rw-r--r-- | docs/configuration/template.md | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/docs/configuration/template.md b/docs/configuration/template.md deleted file mode 100644 index be4d2378a5..0000000000 --- a/docs/configuration/template.md +++ /dev/null @@ -1,51 +0,0 @@ -# EC Feature Configuration Template - -*Short description of the EC feature and the capabilities provided* - -## Config options - -In [config.h], search for options that start with `CONFIG_<feature>*` and -evaluate whether each option is appropriate to add to `baseboard.h` or -`board.h`. - -*Note - Avoid documenting `CONFIG_` options in the markdown as `config.h` -contains the authoritative definition.* - -## Feature Parameters - -*Detail `CONFIG_*` options that must be assigned to a value for this EC feature -to compile and operate.* - -## GPIOs and Alternate Pins - -*Document any hard-coded GPIO enumeration names required by the EC feature.* - -*For pins that require an alternate function, note the module required by the EC -feature.* - -## Data Structures - -*Document any data structures that must be defined in the board.c or baseboard.c -files in order for the EC feature to compile and operate.* - -*Document any functions that must be implemented in the board.c and baseboard.c -files.* - -## Tasks - -*Document any EC tasks that must be enabled by the feature.* - -## Testing and Debugging - -*Provide any tips for testing and debugging the EC feature.* - -### Console Commands - -*Document an EC console commands related to the feature.* - -## Example - -*Optional - provide code snippets from a working board to walk the user through -all code that must be created to enable this feature.* - -[config.h]: ../new_board_checklist.md#config_h |