summaryrefslogtreecommitdiff
path: root/docs/chibios_upgrade_instructions.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/chibios_upgrade_instructions.md')
-rw-r--r--docs/chibios_upgrade_instructions.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/docs/chibios_upgrade_instructions.md b/docs/chibios_upgrade_instructions.md
index 14afe2c743..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`
@@ -57,3 +57,16 @@ ChibiOS and ChibiOS-Contrib need to be updated in tandem -- the latter has a bra
* `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.