Skip to content

Commit b327101

Browse files
committed
README: Add submodule update process section
This commit adds the "Submodule Update Process" section that describes the procedure for updating a submodule in the Zephyr SDK repository. Signed-off-by: Stephanos Ioannidis <[email protected]>
1 parent f4d7082 commit b327101

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,3 +85,22 @@ To create a new Zephyr SDK release:
8585
For more detailed information on the release process, please refer to the
8686
[Release Process](https://github.com/zephyrproject-rtos/sdk-ng/wiki/Release-Process)
8787
document in the wiki.
88+
89+
## Submodule Update Process
90+
91+
The Zephyr SDK repository contains various submodules, such as `binutils` and
92+
`gcc`, required for building the Zephyr SDK.
93+
94+
When updating a submodule, the following procedure should be followed:
95+
96+
- Push a topic branch to the submodule repository.
97+
- Create a pull request from the topic branch to the default (current) branch
98+
of the submodule repository.
99+
- Create a pull request in the Zephyr SDK repository to update the submodule
100+
reference to the tip of the topic (pull request) branch.
101+
- When the pull request in the Zephyr SDK repository passes the CI and the
102+
submodule pull request is sufficiently reviewed, merge the submodule pull
103+
request.
104+
- Update the pull request in the Zephyr SDK repository to reference the merged
105+
commit in the submodule repository.
106+
- Merge the pull request in the Zephyr SDK repository.

0 commit comments

Comments
 (0)