Revert "Update build instructions and docker file to download submodules" #5533
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit 9321054.
drashna
requested review from
mechmerlin,
drashna,
algernon,
ezuk,
fredizzimo,
jackhumbert,
noroadsleft and
skullydazed
vomindoraan
commented
Apr 2, 2019
|
Sure. Thank you for taking care of this!
…On Tue, Apr 2, 2019, 21:54 Konstantin Đorđević ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In docs/getting_started_build_tools.md
<#5533 (comment)>:
> @@ -2,8 +2,6 @@
This page describes setting up the build environment for QMK. These instructions cover AVR processors (such as the atmega32u4).
-After cloning the repo of QMK run `make git-submodule` once to download 3rd party libraries like ChibiOS.
-
<!-- FIXME: We should have ARM instructions somewhere. -->
Note: If it is your first time here, Check out the "Complete Newbs guide" instead
⬇️ Suggested change
- Note: If it is your first time here, Check out the "Complete Newbs guide" instead
+**Note:** If this is your first time here, check out the [Complete Newbs Guide](newbs) page.
+
+Before continuing, check that your submodules (third-party libraries) are up to date by running `make git-submodule`.
@metaflow <https://github.com/metaflow> Does this look good?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#5533 (review)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAPiOylqZie129JADfEh7PyoxhTAqq_Uks5vc7V_gaJpZM4cXgVp>
.
|
drashna
approved these changes
Apr 3, 2019
Shinichi-Ohki
added a commit
to Shinichi-Ohki/qmk_firmware
that referenced
this pull request
Apr 14, 2019
* 'master' of https://github.com/qmk/qmk_firmware: (101 commits) Change table names Cleanup code Make send_char multilined for readaability Clean up some of the code Add AltGr/RALT support to Send String Add vendor and product arguments to atmega32a_program.py - fix hex print Add vendor and product arguments to atmega32a_program.py Max out range for max compatibility Fix ATSAM's USB HID descriptor to support higher heycodes Fix build detection of keymap and board changes Apply MAKEFLAGS to speed up CI Flesh out keymaps and some tweaks to indicators (qmk#5608) add in the missing #defines Update ps2avrgb readme template (qmk#5584) Use DIRECT_PINS for BDN9 (qmk#5603) Port DIRECT_PINS from split_common/matrix.c to matrix.c (qmk#5091) Keyboard: Add yosino58 Keyboard (qmk#5465) fix offset in matrix (qmk#5600) Remove caveat about combos with shared keys (qmk#5601) Revert "Update build instructions and docker file to download submodules" (qmk#5533) ...
shimesaba-type0
pushed a commit
to shimesaba-type0/qmk_firmware
that referenced
this pull request
Jun 22, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reverts #2724
The changes that PR made to the dockerfile and build script are not correct.
make cleanandmake git-submoduleshould not be executed every time the container is run, as this can slow down keymap build times significantly. Submodules should already be present in the directory when the image is built. CI enforces this for official images, and you're supposed to have the submodules cloned ahead of time if you're building a custom image locally.Furthermore, the change to the docs is unnecessary as well, since the guide instructs the user to use
git clone --recurse-submodulesto clone the repo (as can be seen here and here), which also clones the submodules.However, after discussing this with the original PR's author, I've decided that it's a good idea to keep a reminder to run
make git-submodulein the build tools docs.For more details, see the discussion in the original PR.