Add support for conditional submodules updates #377
Merged
Conversation
This file contains hidden or 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
utzig
force-pushed
the
repo-submodule-config
branch
from
e94a29f to
14a8c71
Compare
ccollins476ad
approved these changes
Feb 19, 2020
Contributor
ccollins476ad
left a comment
ccollins476ad
left a comment
There was a problem hiding this comment.
Looks good to me. I just had one minor comment that you can accept or ignore at your discretion.
newt/repo/repo.go
Outdated
| // Check that there is a list of submodules to clone; if the key is | ||
| // not present, assume that all submodules should be cloned, otherwise | ||
| // only those configured will be cloned (or none if "") | ||
| func (r *Repo) loadSubmoduleConfig(yc *ycfg.YCfg) error { |
Contributor
There was a problem hiding this comment.
Other functions that take a ycfg.YCfg object take it by value, not reference. It might make sense to change this function to match the others.
After programming in Go for several years, I still have no idea when to use pointers and when not to, so I am not saying pass-by-value is "better" here, just more consistent :).
Member
Author
There was a problem hiding this comment.
Other functions that take a ycfg.YCfg object take it by value, not reference. It might make sense to change this function to match the others.
Done, thanks!
utzig
force-pushed
the
repo-submodule-config
branch
from
14a8c71 to
0b9306e
Compare
This adds support for repos to inform which submodules are required for a proper build on Mynewt. The main driver for this feature is that the current `ext/mbedtls` on mcuboot is a submodule that is not required by Mynewt builds, and the amount of submodules is going to grow in the future, eg, mcu-tools/mcuboot#653. The way this works is `newt` is going to look for a "repo.submodules" key inside the "repository.yml" file. This is a list of submodules to be cloned. One of two things could happen: 1) If the key is no present `newt` is going to clone all submodules (to preserve compatibility). 2) If the key is found, each of the submodules declared will be cloned one by one. For example, if "repository.yml" has the following contents: ``` repo.submodules: "" ``` In this case submodule cloning is skipped (with a verbose message stating it). ``` repo.submodules: - "ext/mbetls" - "boot/cypress/somemodule" ``` This will clone the two modules declared but not other submodules that might eventually exist. This PR also makes cloning submodules recursive, so submodules inside submodules are also cloned. Signed-off-by: Fabio Utzig <utzig@apache.org>
utzig
added a commit
to utzig/mcuboot
that referenced
this pull request
Feb 25, 2020
A recently added `newt` feature allows it to only clone selected git submodules: apache/mynewt-newt#377. This changes the MCUBoot repository to remove submodules from the cloning process, because they are not used by Mynewt. Signed-off-by: Fabio Utzig <utzig@apache.org>
utzig
added a commit
to mcu-tools/mcuboot
that referenced
this pull request
Feb 25, 2020
A recently added `newt` feature allows it to only clone selected git submodules: apache/mynewt-newt#377. This changes the MCUBoot repository to remove submodules from the cloning process, because they are not used by Mynewt. Signed-off-by: Fabio Utzig <utzig@apache.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This adds support for repos to inform which submodules are required for a proper build on Mynewt. The main driver for this feature is that the current
ext/mbedtlson mcuboot is a submodule that is not required by Mynewt builds, and the amount of submodules is going to grow in the future, eg, mcu-tools/mcuboot#653.The way this works is
newtis going to look for a "repo.submodules" key inside the "repository.yml" file. This is a list of submodules to be cloned. One of two things could happen:newtis going to clone all submodules (to preserve compatibility).For example, if "repository.yml" has the following contents:
In this case submodule cloning is skipped (with a verbose message stating it).
This will clone the two modules declared but not other submodules that might eventually exist.
This PR also makes cloning submodules recursive, so submodules inside submodules are also cloned.