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
From: devel@edk2.groups.io
[mailto:devel@edk2.groups.io] On Behalf Of Andrew Fish via Groups.Io
Sent: Monday, August 26, 2019 2:59 PM
To: Gao, Liming <liming.gao@intel.com>
Cc: devel@edk2.groups.io; rebecca@bsdio.com
Subject: Re: [edk2-devel] git submodule update --init --recursive
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.
From
TianoCore.org I followed this path:
or
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
Thanks,
Andrew Fish