Andrew,
I agree the documentation for this should be in the same section as the clone requirements.
This operation is not always required. Right now, if a platform does not use OpenSSL in CryptoPkg, then the submodule operation can be skipped.
The documentation should let the developer know when it is required.
Mike
Liming,
I see the usage of Submodules is documented at the end of the Readme.md. I would not think of going to a Submodules section to figure out how to get started or clone the repo.
I did not think of reading the full Readme.md as most of it is about "How to Contribute to" not how to use the repo.
The git clone instructions don't include the "git submodule update --init" instructions and the OVMF build failed.
bash$ mkdir ~/src
bash$ cd ~/src
bash$ git clone https://github.com/tianocore/edk2
edk2\Readme.md Submodules section gives the command to update edk2 project.
Thanks
Liming
I was following the instructions on how to build OVMF and my build failed. It
looks like the reason it failed was because I did not do a `git submodule
update --init --recursive`. It would be good if we could make how to clone the
edk2 instructions a bit more obvious.
I think we came to the conclusion that "--recursive" isn't needed. But
I've found that there are cases where "--force" is required to make sure
git checks out a submodule correctly.
--
Rebecca Cran