diff options
Diffstat (limited to 'docs/chibios_upgrade_instructions.md')
| -rw-r--r-- | docs/chibios_upgrade_instructions.md | 19 |
1 files changed, 16 insertions, 3 deletions
diff --git a/docs/chibios_upgrade_instructions.md b/docs/chibios_upgrade_instructions.md index b0a71142a3..62f16d0d25 100644 --- a/docs/chibios_upgrade_instructions.md +++ b/docs/chibios_upgrade_instructions.md @@ -4,7 +4,7 @@ ChibiOS and ChibiOS-Contrib need to be updated in tandem -- the latter has a bra ## Getting ChibiOS -* `svn` Initialisation: +* `svn` Initialization: * Only needed to be done once * You might need to separately install `git-svn` package in your OS's package manager * `git svn init --stdlayout --prefix='svn/' http://svn.osdn.net/svnroot/chibios/` @@ -21,7 +21,7 @@ ChibiOS and ChibiOS-Contrib need to be updated in tandem -- the latter has a bra ## Getting ChibiOS-Contrib -* `git` Initialisation: +* `git` Initialization: * `git clone git@github.com:qmk/ChibiOS-Contrib` * `git remote add upstream https://github.com/ChibiOS/ChibiOS-Contrib` * `git checkout -b chibios-20.3.x upstream/chibios-20.3.x` @@ -51,9 +51,22 @@ ChibiOS and ChibiOS-Contrib need to be updated in tandem -- the latter has a bra * `./util/chibios_conf_updater.sh` * Build everything * `cd $QMK_FIRMWARE` - * `qmk multibuild -j4` + * `qmk mass-compile -j 4` * Make sure there are no errors * Push to the repo * `git commit -am 'Update ChibiOS to 99.9.9'` * `git push --set-upstream origin chibios-version-bump` * Make a PR to qmk_firmware with the new branch + +## When merging a PR containing an upgrade of ChibiOS/ChibiOS-Contrib: + +* Update the target branch if the merge target was `master`: + * `git checkout qmk-master` + * `git reset --hard develop_YYYY_qN` + * `git push origin qmk-master --force-with-lease` +* Update the target branch if the merge target was `develop`: + * `git checkout qmk-develop` + * `git reset --hard develop_YYYY_qN` + * `git push origin qmk-develop --force-with-lease` + +Note that when merging `develop` to `master`, the first workflow should still be followed. |