From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mx.groups.io; dkim=pass header.i=@apple.com header.s=20180706 header.b=M06wp5kp; spf=pass (domain: apple.com, ip: 17.171.2.72, mailfrom: afish@apple.com) Received: from ma1-aaemail-dr-lapp03.apple.com (ma1-aaemail-dr-lapp03.apple.com [17.171.2.72]) by groups.io with SMTP; Mon, 26 Aug 2019 15:32:03 -0700 Received: from pps.filterd (ma1-aaemail-dr-lapp03.apple.com [127.0.0.1]) by ma1-aaemail-dr-lapp03.apple.com (8.16.0.27/8.16.0.27) with SMTP id x7QMVcZQ051230; Mon, 26 Aug 2019 15:31:58 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=apple.com; h=sender : from : message-id : content-type : mime-version : subject : date : in-reply-to : cc : to : references; s=20180706; bh=Ipg3Ba1auDq6+QQEl+sA0nyRsFpW90ciI0lmhVNRriA=; b=M06wp5kpYJ6NRrSZYGGeCNxt020aiPddXFiaPPrgaelb1601+bz9BtoHVBm6tkjYk202 eQhaJVJj8GGNfNYDdsKLjnunSHzJOf5oNE/4hJklrVrJChCz40F3HxdNAvXf9OxPX1+Q RT58lPxlKhCO1RsFmPR7u8h7MpzwZIPqkb+XhvTSUAHixP66jlKZXZFOwyBqujXaU44h 6VTukk6Fxs9NLs78xsMqy2QOl0SkXz4s+tXz0XhK6mAS+Wb2V82+uP24qvA2KB+3nL4M wIghVsfGwgWMFjfvIJN0qa7gMuMZt31lKIC4S80a5bw0NIY8QdPmaFKQKlcU7dIEjaWF rA== Received: from ma1-mtap-s02.corp.apple.com (ma1-mtap-s02.corp.apple.com [17.40.76.6]) by ma1-aaemail-dr-lapp03.apple.com with ESMTP id 2uk481ujmp-14 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128 verify=NO); Mon, 26 Aug 2019 15:31:58 -0700 Received: from nwk-mmpp-sz09.apple.com (nwk-mmpp-sz09.apple.com [17.128.115.80]) by ma1-mtap-s02.corp.apple.com (Oracle Communications Messaging Server 8.0.2.4.20190507 64bit (built May 7 2019)) with ESMTPS id <0PWV008YY7X5IJ50@ma1-mtap-s02.corp.apple.com>; Mon, 26 Aug 2019 15:31:58 -0700 (PDT) Received: from process_milters-daemon.nwk-mmpp-sz09.apple.com by nwk-mmpp-sz09.apple.com (Oracle Communications Messaging Server 8.0.2.4.20190507 64bit (built May 7 2019)) id <0PWV00G007M8GK00@nwk-mmpp-sz09.apple.com>; Mon, 26 Aug 2019 15:31:57 -0700 (PDT) X-Va-A: X-Va-T-CD: e48e8dc3f6c377b8dc939b4126ad19f3 X-Va-E-CD: 7be8c6f9a457bfa738490035d2e183d8 X-Va-R-CD: 28cfb432f63ff0d30657baef1c1a3c05 X-Va-CD: 0 X-Va-ID: 545c8795-881d-4e99-9bb8-b6d5b5c36aa2 X-V-A: X-V-T-CD: e48e8dc3f6c377b8dc939b4126ad19f3 X-V-E-CD: 7be8c6f9a457bfa738490035d2e183d8 X-V-R-CD: 28cfb432f63ff0d30657baef1c1a3c05 X-V-CD: 0 X-V-ID: c9199d3a-3f8c-4831-b139-2a53e402ccf9 X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:,, definitions=2019-08-26_08:,, signatures=0 Received: from [17.235.30.66] (unknown [17.235.30.66]) by nwk-mmpp-sz09.apple.com (Oracle Communications Messaging Server 8.0.2.4.20190507 64bit (built May 7 2019)) with ESMTPSA id <0PWV003S57STW570@nwk-mmpp-sz09.apple.com>; Mon, 26 Aug 2019 15:29:18 -0700 (PDT) Sender: afish@apple.com From: "Andrew Fish" Message-id: <4649CCEF-8C33-44C5-8A3F-6EFA0E549DA2@apple.com> MIME-version: 1.0 (Mac OS X Mail 12.4 \(3445.104.11\)) Subject: Re: [edk2-devel] git submodule update --init --recursive Date: Mon, 26 Aug 2019 15:29:12 -0700 In-reply-to: Cc: "Gao, Liming" , "rebecca@bsdio.com" To: devel@edk2.groups.io, Mike Kinney References: <83E89A1F-25F0-40ED-BE33-6843030DFEE4@apple.com> <35027f0c-51f3-a37a-c94a-b3df084c3981@bsdio.com> <4A89E2EF3DFEDB4C8BFDE51014F606A14E4DC1E6@SHSMSX104.ccr.corp.intel.com> <0ED23C22-D224-40E0-BB57-ACA8F1ABCEA1@apple.com> X-Mailer: Apple Mail (2.3445.104.11) X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:,, definitions=2019-08-26_08:,, signatures=0 Content-type: multipart/alternative; boundary="Apple-Mail=_11A5BD2A-7C00-42E9-A5A9-B3BA37A99FDD" --Apple-Mail=_11A5BD2A-7C00-42E9-A5A9-B3BA37A99FDD Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=utf-8 Mike, I hit it when I was testing an OVMF build. It looks like the OVMF instruct= ions reference the generic getting started guide that omits the submodule u= pdate command.=20 Thanks, Andrew Fish > On Aug 26, 2019, at 3:11 PM, Michael D Kinney wrote: >=20 > 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 no= t use OpenSSL in CryptoPkg, then the submodule operation can be skipped. > > The documentation should let the developer know when it is required. > > Mike > =C2=A0 <> > From: devel@edk2.groups.io [mailto:devel@e= dk2.groups.io ] On Behalf Of Andrew Fish via G= roups.Io > Sent: Monday, August 26, 2019 2:59 PM > To: Gao, Liming > > Cc: devel@edk2.groups.io ; rebecca@bsdio.co= m > 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 ge= t started or clone the repo.=20 > > I did not think of reading the full Readme.md as most of it is about "H= ow to Contribute to" not how to use the repo.=20 > > From TianoCore.org I followed this path: > https://www.tianocore.org/getting-started.html > https://github.com/tianocore/tianocore.github.io/wiki/Getting-Started-wi= th-EDK-II > > https://github.com/tianocore/tianocore.github.io/wiki/Windows-systems > or > https://github.com/tianocore/tianocore.github.io/wiki/Common-instruction= s-for-Unix > > > The git clone instructions don't include the "git submodule update --ini= t" instructions and the OVMF build failed.=20 > > bash$ mkdir ~/src > bash$ cd ~/src > bash$ git clone https://github.com/tianocore/edk2 > > Thanks, > > Andrew Fish >=20 >=20 > On Aug 25, 2019, at 8:54 PM, Gao, Liming > wrote: > > edk2\Readme.md Submodules section gives the command to update edk2 proje= ct.=20 >=20 > Thanks > Liming >=20 > -----Original Message----- > From: devel@edk2.groups.io [mailto:devel@e= dk2.groups.io ] On Behalf Of > rebecca@bsdio.com > Sent: Saturday, August 24, 2019 6:24 AM > To: devel@edk2.groups.io ; afish@apple.com = > Subject: Re: [edk2-devel] git submodule update --init --recursive >=20 > On 2019-08-23 14:41, Andrew Fish via Groups.Io wrote: >=20 > I was following the instructions on how to build OVMF and my build faile= d. It > looks like the reason it failed was because I did not do a `git submodul= e > update --init --recursive`. It would be good if we could make how to clo= ne the > edk2 instructions a bit more obvious. >=20 >=20 > 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. >=20 >=20 > -- > Rebecca Cran >=20 >=20 >=20 > > >=20 --Apple-Mail=_11A5BD2A-7C00-42E9-A5A9-B3BA37A99FDD Content-Transfer-Encoding: quoted-printable Content-Type: text/html; charset=us-ascii Mike,
<= br class=3D"">
I hit it when I was testing an OVMF bui= ld. It looks like the OVMF instructions reference the generic getting start= ed guide that omits the submodule update command. 

Thanks,

Andrew Fish

On Aug 26, 2019, at 3= :11 PM, Michael D Kinney <michael.d.kinney@intel.com> wrote:

Andrew,
 
I agree the documentation for this shoul= d be in the same section as the clone requirements.
 
This operation is not always re= quired.  <= /span>Right now, if a platform does not use OpenSSL in CryptoPkg, then the submodule operation can be skipped.
 
The documentation should let the de= veloper know when it is required.
 
= Mike
<= span style=3D"font-size: 11pt; font-family: Calibri, sans-serif; color: rgb= (31, 73, 125);" class=3D""> 
From: = devel@edk2.groups.io [mailto:de= vel@edk2.groups.io] <= b class=3D"">On Behalf Of Andrew Fish via Groups.Io
Sent: Monday, August 26, 2019 2:59 PM=
To:&= nbsp;Gao, Liming <liming.gao@inte= l.com>
Cc: devel@edk2.groups.io<= /a>; 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. 
<= o:p class=3D""> 
I did not th= ink of reading the full  Readme.md as most of it is about "How to= Contribute to" not how to use the repo. =
 
From Tiano= Core.org I followed t= his path:
https://www.tianocore.org/getting-started.html<= o:p class=3D"">
https://github.com/tianoco= re/tianocore.github.io/wiki/Getting-Started-with-EDK-II=
 
<= a href=3D"https://github.com/tianocore/tianocore.github.io/wiki/Windows-sys= tems" style=3D"color: purple; text-decoration: underline;" class=3D"">https= ://github.com/tianocore/tianocore.github.io/wiki/Windows-systems
or
https://github.com/tianocore/tianocore.github.io/wiki/Commo= n-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 <liming.gao@intel.com> wrote:
 
edk2\R= eadme.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
rebecca@bsdio.com
Sent: Saturday, August 24= , 2019 6:24 AM
To: = ;devel@edk2.groups.io; afish@appl= e.com
Subject: Re: [edk2-devel] git submodule update --in= it --recursive

On 2019-08-23 14:41, Andrew Fis= h via Groups.Io wrote:

<= /span>
I was fo= llowing 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 w= ould be good if we could make how to clone the
edk2 instructi= ons 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


 =
 


--Apple-Mail=_11A5BD2A-7C00-42E9-A5A9-B3BA37A99FDD--