aboutsummaryrefslogtreecommitdiff
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.md23
1 files changed, 13 insertions, 10 deletions
diff --git a/docs/chibios_upgrade_instructions.md b/docs/chibios_upgrade_instructions.md
index 40c2faafc..b0a71142a 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
14 * First time around this will take several hours 14 * First time around this will take several hours
15 * Subsequent updates will be incremental only 15 * Subsequent updates will be incremental only
16* Tagging example (work out which version first!): 16* Tagging example (work out which version first!):
17 * `git tag -a ver20.3.3 -m ver20.3.3 svn/tags/ver20.3.3` 17 * `git tag -a ver20.3.4 -m ver20.3.4 svn/tags/ver20.3.4`
18 * `git push qmk ver20.3.3` 18 * `git push qmk ver20.3.4`
19 * `git tag -a breaking_YYYY_qN -m breaking_YYYY_qN svn/tags/ver20.3.3` 19 * `git tag -a develop_YYYY_qN -m develop_YYYY_qN svn/tags/ver20.3.4`
20 * `git push qmk breaking_YYYY_qN` 20 * `git push qmk develop_YYYY_qN`
21 21
22## Getting ChibiOS-Contrib 22## Getting ChibiOS-Contrib
23 23
@@ -30,8 +30,8 @@ ChibiOS and ChibiOS-Contrib need to be updated in tandem -- the latter has a bra
30 * `git checkout chibios-20.3.x` 30 * `git checkout chibios-20.3.x`
31 * `git pull --ff-only` 31 * `git pull --ff-only`
32 * `git push origin chibios-20.3.x` 32 * `git push origin chibios-20.3.x`
33 * `git tag -a breaking_YYYY_qN -m breaking_YYYY_qN chibios-20.3.x` 33 * `git tag -a develop_YYYY_qN -m develop_YYYY_qN chibios-20.3.x`
34 * `git push origin breaking_YYYY_qN` 34 * `git push origin develop_YYYY_qN`
35 35
36## Updating submodules 36## Updating submodules
37 37
@@ -42,15 +42,18 @@ ChibiOS and ChibiOS-Contrib need to be updated in tandem -- the latter has a bra
42 * `git checkout -b chibios-version-bump` 42 * `git checkout -b chibios-version-bump`
43 * `cd lib/chibios` 43 * `cd lib/chibios`
44 * `git fetch --all --tags --prune` 44 * `git fetch --all --tags --prune`
45 * `git checkout breaking_YYYY_qN` 45 * `git checkout develop_YYYY_qN`
46 * `cd ../chibios-contrib` 46 * `cd ../chibios-contrib`
47 * `git fetch --all --tags --prune` 47 * `git fetch --all --tags --prune`
48 * `git checkout breaking_YYYY_qN` 48 * `git checkout develop_YYYY_qN`
49* Update ChibiOS configs within QMK
50 * `cd $QMK_FIRMWARE`
51 * `./util/chibios_conf_updater.sh`
49* Build everything 52* Build everything
50 * `cd $QMK_FIRMWARE` 53 * `cd $QMK_FIRMWARE`
51 * `qmk multibuild -j4` 54 * `qmk multibuild -j4`
52 * Make sure there are no errors 55 * Make sure there are no errors
53* Push to the repo 56* Push to the repo
54 * `git commit -am 'Update ChibiOS to XXXXXXXXX'` 57 * `git commit -am 'Update ChibiOS to 99.9.9'`
55 * `git push --set-upstream origin chibios-version-bump` 58 * `git push --set-upstream origin chibios-version-bump`
56* Make a PR to qmk_firmware with the new branch \ No newline at end of file 59* Make a PR to qmk_firmware with the new branch