← index #14536PR #8894
Related · high · value 0.627
QUERY · ISSUE

docs: Windows port README should include `make submodule` as a build step

openby mattytrentiniopened 2024-05-19updated 2024-07-06
docsport-windows

Checks

  • I agree to follow the MicroPython Code of Conduct to ensure a safe and respectful space for everyone.

  • I've searched for existing issues and didn't find any that matched.

Documentation URL

https://github.com/micropython/micropython/blob/master/ports/windows/README.md

Description

The build steps for the Windows port are missing make submodule. Build errors occur because micropython-lib (specifically the ssl module) isn't found if that command isn't executed.

CANDIDATE · PULL REQUEST

lib: Add micropython-lib submodule.

closedby jimmoopened 2022-07-11updated 2022-08-02

As discussed in #8860.

Most of this PR is handling how to make make submodules behave sensibly.
The rule I've chosen is that if you are using a frozen manifest, then micropython-lib should be included.

This was trivial in Make (although I needed to make all updates of the GIT_SUBMODULES variable appends rather than overwrites), but it was a total pain in CMake.

For micropython-lib honestly it would be probably fine to just always unconditionally include in in make submodules but I kind of wanted to sort this out so that board-specific dependencies become possible.

In the end it works for rp2, but for esp32 I had to just force it to always use micropython-lib (honestly this makes sense anyway) and we'll need to revisit this if we want to do board-specific submodules on ESP32.

Keyboard

j / / n
next pair
k / / p
previous pair
1 / / h
show query pane
2 / / l
show candidate pane
c
copy suggested comment
r
toggle reasoning
g i
go to index
?
show this help
esc
close overlays

press ? or esc to close

copied