summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/chibios_upgrade_instructions.md23
1 files changed, 13 insertions, 10 deletions
diff --git a/docs/chibios_upgrade_instructions.md b/docs/chibios_upgrade_instructions.md
index 40c2faafcf..b0a71142a3 100644
--- a/docs/chibios_upgrade_instructions.md
+++ b/docs/chibios_upgrade_instructions.md
@@ -14,10 +14,10 @@ ChibiOS and ChibiOS-Contrib need to be updated in tandem -- the latter has a bra
* First time around this will take several hours
* Subsequent updates will be incremental only
* Tagging example (work out which version first!):
- * `git tag -a ver20.3.3 -m ver20.3.3 svn/tags/ver20.3.3`
- * `git push qmk ver20.3.3`
- * `git tag -a breaking_YYYY_qN -m breaking_YYYY_qN svn/tags/ver20.3.3`
- * `git push qmk breaking_YYYY_qN`
+ * `git tag -a ver20.3.4 -m ver20.3.4 svn/tags/ver20.3.4`
+ * `git push qmk ver20.3.4`
+ * `git tag -a develop_YYYY_qN -m develop_YYYY_qN svn/tags/ver20.3.4`
+ * `git push qmk develop_YYYY_qN`
## Getting ChibiOS-Contrib
@@ -30,8 +30,8 @@ ChibiOS and ChibiOS-Contrib need to be updated in tandem -- the latter has a bra
* `git checkout chibios-20.3.x`
* `git pull --ff-only`
* `git push origin chibios-20.3.x`
- * `git tag -a breaking_YYYY_qN -m breaking_YYYY_qN chibios-20.3.x`
- * `git push origin breaking_YYYY_qN`
+ * `git tag -a develop_YYYY_qN -m develop_YYYY_qN chibios-20.3.x`
+ * `git push origin develop_YYYY_qN`
## Updating submodules
@@ -42,15 +42,18 @@ ChibiOS and ChibiOS-Contrib need to be updated in tandem -- the latter has a bra
* `git checkout -b chibios-version-bump`
* `cd lib/chibios`
* `git fetch --all --tags --prune`
- * `git checkout breaking_YYYY_qN`
+ * `git checkout develop_YYYY_qN`
* `cd ../chibios-contrib`
* `git fetch --all --tags --prune`
- * `git checkout breaking_YYYY_qN`
+ * `git checkout develop_YYYY_qN`
+* Update ChibiOS configs within QMK
+ * `cd $QMK_FIRMWARE`
+ * `./util/chibios_conf_updater.sh`
* Build everything
* `cd $QMK_FIRMWARE`
* `qmk multibuild -j4`
* Make sure there are no errors
* Push to the repo
- * `git commit -am 'Update ChibiOS to XXXXXXXXX'`
+ * `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 \ No newline at end of file
+* Make a PR to qmk_firmware with the new branch