Re: [edk2-devel] git submodule update --init --recursive
(+Jordan and Gary) On 08/27/19 00:29, Andrew Fish via Groups.Io wrote: > Mike, > > I hit it when I was testing an OVMF build. It looks like the OVMF > instructions reference the generic getting started guide that omits the > submodule update command. I agree that the "BUILDING OVMF" section in "OvmfPkg/README" is out of date. I think a bugzilla ticket would be justified. Personally, I wouldn't like to propose actual patches, for improving this part of "OvmfPkg/README". For me, the best way for building OVMF has always been to write my own build scripts. In our downstream edk2 repositories at Red Hat, I provide a text file with detailed commands that basically amount to the same. I think that, technically speaking, the same could work for the "OvmfPkg/README" file too. But my understanding is that many in the upstream community dislike this approach -- many people prefer "OvmfPkg/build.sh" instead (which I never use -- it *is* a build script alright, but it's quite different from what I use). "OvmfPkg/README" does mention "OvmfPkg/build.sh" in the "Build Scripts" section. So maybe "OvmfPkg/build.sh" should be patched, to verify that the OpenSSL submodule has been initialized. That could be another BZ (or another patch in the series for the same BZ). Thanks Laszlo -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#46477): https://edk2.groups.io/g/devel/message/46477 Mute This Topic: https://groups.io/mt/33005553/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] git submodule update --init --recursive
Mike, I hit it when I was testing an OVMF build. It looks like the OVMF instructions reference the generic getting started guide that omits the submodule update command. Thanks, Andrew Fish > On Aug 26, 2019, at 3:11 PM, Michael D Kinney > wrote: > > 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> > [mailto: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 mailto:liming@intel.com>> > Cc: devel@edk2.groups.io <mailto:devel@edk2.groups.io>; rebe...@bsdio.com > <mailto:rebe...@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 <http://tianocore.org/> I followed this path: > https://www.tianocore.org/getting-started.html > <https://www.tianocore.org/getting-started.html> > https://github.com/tianocore/tianocore.github.io/wiki/Getting-Started-with-EDK-II > > <https://github.com/tianocore/tianocore.github.io/wiki/Getting-Started-with-EDK-II> > > https://github.com/tianocore/tianocore.github.io/wiki/Windows-systems > <https://github.com/tianocore/tianocore.github.io/wiki/Windows-systems> > or > https://github.com/tianocore/tianocore.github.io/wiki/Common-instructions-for-Unix > > <https://github.com/tianocore/tianocore.github.io/wiki/Common-instructions-for-Unix> > > > 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 > <https://github.com/tianocore/edk2> > > Thanks, > > Andrew Fish > > > On Aug 25, 2019, at 8:54 PM, Gao, Liming <mailto:liming@intel.com>> wrote: > > edk2\Readme.md Submodules section gives the command to update edk2 project. > > Thanks > Liming > > -Original Message- > From: devel@edk2.groups.io <mailto:devel@edk2.groups.io> > [mailto:devel@edk2.groups.io <mailto:devel@edk2.groups.io>] On Behalf Of > rebe...@bsdio.com <mailto:rebe...@bsdio.com> > Sent: Saturday, August 24, 2019 6:24 AM > To: devel@edk2.groups.io <mailto:devel@edk2.groups.io>; af...@apple.com > <mailto:af...@apple.com> > Subject: Re: [edk2-devel] git submodule update --init --recursive > > On 2019-08-23 14:41, Andrew Fish via Groups.Io wrote: > > 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 > > > > > > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#46378): https://edk2.groups.io/g/devel/message/46378 Mute This Topic: https://groups.io/mt/33005553/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] git submodule update --init --recursive
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 Cc: devel@edk2.groups.io; rebe...@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<http://TianoCore.org> I followed this path: https://www.tianocore.org/getting-started.html https://github.com/tianocore/tianocore.github.io/wiki/Getting-Started-with-EDK-II https://github.com/tianocore/tianocore.github.io/wiki/Windows-systems or https://github.com/tianocore/tianocore.github.io/wiki/Common-instructions-for-Unix 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 On Aug 25, 2019, at 8:54 PM, Gao, Liming mailto:liming@intel.com>> wrote: edk2\Readme.md Submodules section gives the command to update edk2 project. Thanks Liming -Original Message- From: devel@edk2.groups.io<mailto:devel@edk2.groups.io> [mailto:devel@edk2.groups.io] On Behalf Of rebe...@bsdio.com<mailto:rebe...@bsdio.com> Sent: Saturday, August 24, 2019 6:24 AM To: devel@edk2.groups.io<mailto:devel@edk2.groups.io>; af...@apple.com<mailto:af...@apple.com> Subject: Re: [edk2-devel] git submodule update --init --recursive On 2019-08-23 14:41, Andrew Fish via Groups.Io wrote: 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 -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#46377): https://edk2.groups.io/g/devel/message/46377 Mute This Topic: https://groups.io/mt/33005553/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
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: https://www.tianocore.org/getting-started.html https://github.com/tianocore/tianocore.github.io/wiki/Getting-Started-with-EDK-II https://github.com/tianocore/tianocore.github.io/wiki/Windows-systems or https://github.com/tianocore/tianocore.github.io/wiki/Common-instructions-for-Unix 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 > On Aug 25, 2019, at 8:54 PM, Gao, Liming wrote: > > edk2\Readme.md Submodules section gives the command to update edk2 project. > > Thanks > Liming >> -Original Message- >> From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of >> rebe...@bsdio.com >> Sent: Saturday, August 24, 2019 6:24 AM >> To: devel@edk2.groups.io; af...@apple.com >> Subject: Re: [edk2-devel] git submodule update --init --recursive >> >> On 2019-08-23 14:41, Andrew Fish via Groups.Io wrote: >>> 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 >> >> >> > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#46375): https://edk2.groups.io/g/devel/message/46375 Mute This Topic: https://groups.io/mt/33005553/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] git submodule update --init --recursive
edk2\Readme.md Submodules section gives the command to update edk2 project. Thanks Liming >-Original Message- >From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of >rebe...@bsdio.com >Sent: Saturday, August 24, 2019 6:24 AM >To: devel@edk2.groups.io; af...@apple.com >Subject: Re: [edk2-devel] git submodule update --init --recursive > >On 2019-08-23 14:41, Andrew Fish via Groups.Io wrote: >> 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 > > > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#46353): https://edk2.groups.io/g/devel/message/46353 Mute This Topic: https://groups.io/mt/33005553/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] git submodule update --init --recursive
On 2019-08-23 14:41, Andrew Fish via Groups.Io wrote: > 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 -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#46338): https://edk2.groups.io/g/devel/message/46338 Mute This Topic: https://groups.io/mt/33005553/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
[edk2-devel] git submodule update --init --recursive
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. Thanks, Andrew Fish -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#46327): https://edk2.groups.io/g/devel/message/46327 Mute This Topic: https://groups.io/mt/33005553/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
