Re: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands
Liming, > -Original Message- > From: Gao, Liming > Sent: Wednesday, July 10, 2019 3:44 PM > To: devel@edk2.groups.io; Wang, Jian J > Cc: Leif Lindholm ; Kinney, Michael D > > Subject: RE: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule > policy and clone commands > > Jian: > > >-Original Message- > >From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of > >Wang, Jian J > >Sent: Wednesday, July 10, 2019 2:10 PM > >To: devel@edk2.groups.io > >Cc: Leif Lindholm ; Kinney, Michael D > >; Gao, Liming > >Subject: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule policy > and > >clone commands > > > >> v2: update wording per Leif's and others' comments > > > >REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1910 > > > >A section 'Submodules' is added to clarify the submodule policy > >in edk2 repo. Git commands are also added to show the correct > >way to clone submodule repos, in which '--recursive' is removed > >because it's not needed but recommended in other document. > > > >Related commits: > >Openssl-1.1.1b upgrade: acfb90911840c38a0beb9bcfe0065668244d2b4d > >berkeley-softfloat-3: 3cc57695df5a6e8c65fb46b993836c315cabf49d > > > >Cc: Leif Lindholm > >Cc: Michael D Kinney > >Cc: Liming Gao > >Signed-off-by: Jian J Wang > >--- > > Readme.md | 28 > > 1 file changed, 28 insertions(+) > > > >diff --git a/Readme.md b/Readme.md > >index e564c6c09b..c475468655 100644 > >--- a/Readme.md > >+++ b/Readme.md > >@@ -143,3 +143,31 @@ Signed-off-by: Contributor Name > > > > the change. Each line should be less than ~70 characters. > > * `Signed-off-by` is the contributor's signature identifying them > > by their real/legal name and their email address. > >+ > >+# Submodules > >+ > >+As a general policy, submodule chain should be avoided in EDK II repo > >+as possible as we can. Currently EDK II contains two submodules > Here, I understand to avoid the child submodule, and the root submodule is > allowed. > Besides, there is two spaces between EDK II contains. Please take care. > No exactly. I think it's dependency chain, i.e. one submodule depends on another submodule. It's out of our control that one submodule imports other submodules in its repo. What about changing the first statement to following: Submodule is allowed to import 3rd party code into EDK II repo. But submodules that require further submodules should be avoided as possible as we can. And I'll remove the extra space here. > >+ > >+- CryptoPkg/Library/OpensslLib/openssl > >+- ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3 > >+ > >+The latter one is actually required by previous one. It's inevitable > >+in openssl-1.1.1 (since stable201905) for floating point parameter > >+conversion, but should be dropped once there's no such need in future > >+release of openssl. > >+ > >+To get a full, buildable EDK II repository, use following two steps > >+of git command > >+ > >+``` > >+$ git clone https://github.com/tianocore/edk2.git > >+$ git submodule update --init > >+``` > >+ > Please also give the update command for submodule. > I'll add it. > Thanks > Liming > >+Note: When cloning submodule repos, '--recursive' option is not > >+recommended. EDK II itself will not use any code/feature from > >+submodules in above submodules. So using '--recursive' adds a > >+dependency on being able to reach servers we do not actually want > >+any code from, as well as needlessly downloading code we will not > >+use. > >-- > >2.17.1.windows.2 > > > > > > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#43581): https://edk2.groups.io/g/devel/message/43581 Mute This Topic: https://groups.io/mt/32413655/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands
Mike, > -Original Message- > From: Kinney, Michael D > Sent: Thursday, July 11, 2019 1:28 AM > To: Leif Lindholm ; Kinney, Michael D > > Cc: Wang, Jian J ; devel@edk2.groups.io; Gao, > Liming > Subject: RE: [ PATCH v2 1/2] Readme.md: add submodule policy and clone > commands > > > > > -Original Message- > > From: Leif Lindholm [mailto:leif.lindh...@linaro.org] > > Sent: Wednesday, July 10, 2019 10:18 AM > > To: Kinney, Michael D > > Cc: Wang, Jian J ; > > devel@edk2.groups.io; Gao, Liming > > Subject: Re: [ PATCH v2 1/2] Readme.md: add submodule > > policy and clone commands > > > > On Wed, Jul 10, 2019 at 05:08:32PM +, Kinney, Michael > > D wrote: > > > Leif, > > > > > > I think the following command has to be run from the > > git dir that the > > > edk2 repo was cloned into. > > > > > > $ git submodule update --init > > > > > > So I think the correct instructions would be: > > > > > > $ git clone https://github.com/tianocore/edk2.git > > > $ cd edk2 > > > $ git submodule update --init > > > > I only said I reviewed it, not that the review was > > correct ;) > > > > Yeah, good catch. I just mentally filtered out the clone > > bit. > > > > > $ cd .. > > > > Why would you want to leave? > > Because the commands the follow are more clone commands for > edk2-platforms and edk2-non-osi. Could move the submodule > init action for the edk2 repo after all the clone operations. > Thanks for catching the issue. I'll update the edk2/Readme.md. Then the edk2-platforms/Readme.md has the same issue. It will be updated as well. Regards, Jian > > > > / > > Leif > > > > > Mike > > > > > > > -Original Message- > > > > From: Leif Lindholm [mailto:leif.lindh...@linaro.org] > > > > Sent: Wednesday, July 10, 2019 7:27 AM > > > > To: Wang, Jian J > > > > Cc: devel@edk2.groups.io; Kinney, Michael D > > > > ; Gao, Liming > > > > > > Subject: Re: [ PATCH v2 1/2] Readme.md: add submodule > > policy and > > > > clone commands > > > > > > > > On Wed, Jul 10, 2019 at 02:09:54PM +0800, Jian J Wang > > > > wrote: > > > > > > v2: update wording per Leif's and others' > > comments > > > > > > > > Please drop the above line - version comments can go > > below the --- > > > > line, so they don't get included in the commit > > message. > > > > > > > > With that: > > > > Reviewed-by: Leif Lindholm > > > > > > > > (although Liming had some further feedback) > > > > > > > > > REF: > > > > https://bugzilla.tianocore.org/show_bug.cgi?id=1910 > > > > > > > > > > A section 'Submodules' is added to clarify the > > > > submodule policy in > > > > > edk2 repo. Git commands are also added to show the > > > > correct way to > > > > > clone submodule repos, in which '--recursive' is > > > > removed because it's > > > > > not needed but recommended in other document. > > > > > > > > > > Related commits: > > > > > Openssl-1.1.1b upgrade: > > > > acfb90911840c38a0beb9bcfe0065668244d2b4d > > > > > berkeley-softfloat-3: > > > > 3cc57695df5a6e8c65fb46b993836c315cabf49d > > > > > > > > > > Cc: Leif Lindholm > > > > > Cc: Michael D Kinney > > > > > Cc: Liming Gao > > > > > Signed-off-by: Jian J Wang > > > > > --- > > > > > Readme.md | 28 > > > > > 1 file changed, 28 insertions(+) > > > > > > > > > > diff --git a/Readme.md b/Readme.md index > > e564c6c09b..c475468655 > > > > > 100644 > > > > > --- a/Readme.md > > > > > +++ b/Readme.md > > > > > @@ -143,3 +143,31 @@ Signed-off-by: Contributor > > Name > > > > > > > > >the change. Each line should be less than ~70 > > > > characters. > > > > > * `Signed-off-by` is the contributor's signature > > > > identifying them > > > > >by their real/legal name and their email > > address. > > > > > + > > > > > +# Submodules > > > > > + > > > > > +As a general policy, submodule chain should be > > avoided > > > > in EDK II repo > > > > > +as possible as we can. Currently EDK II contains > > two > > > > submodules > > > > > + > > > > > +- CryptoPkg/Library/OpensslLib/openssl > > > > > +- ArmPkg/Library/ArmSoftFloatLib/berkeley- > > softfloat-3 > > > > > + > > > > > +The latter one is actually required by previous > > one. > > > > It's inevitable > > > > > +in openssl-1.1.1 (since stable201905) for floating > > > > point parameter > > > > > +conversion, but should be dropped once there's no > > such > > > > need in future > > > > > +release of openssl. > > > > > + > > > > > +To get a full, buildable EDK II repository, use > > > > following two steps > > > > > +of git command > > > > > + > > > > > +``` > > > > > +$ git clone https://github.com/tianocore/edk2.git > > > > > +$ git submodule update --init> > +``` > > > > > + > > > > > +Note: When cloning submodule repos, '--recursive' > > > > option is not > > > > > +recommended. EDK II itself will not use any > > > > code/feature from > > > > > +submodules in above submodules. So using '-- > > recursive' > > > > adds a > > > > > +dependency on being able to reach servers we do > > not >
Re: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands
On Wed, Jul 10, 2019 at 05:28:27PM +, Kinney, Michael D wrote: > > > > -Original Message- > > From: Leif Lindholm [mailto:leif.lindh...@linaro.org] > > Sent: Wednesday, July 10, 2019 10:18 AM > > To: Kinney, Michael D > > Cc: Wang, Jian J ; > > devel@edk2.groups.io; Gao, Liming > > Subject: Re: [ PATCH v2 1/2] Readme.md: add submodule > > policy and clone commands > > > > On Wed, Jul 10, 2019 at 05:08:32PM +, Kinney, Michael > > D wrote: > > > Leif, > > > > > > I think the following command has to be run from the > > git dir that the > > > edk2 repo was cloned into. > > > > > > $ git submodule update --init > > > > > > So I think the correct instructions would be: > > > > > > $ git clone https://github.com/tianocore/edk2.git > > > $ cd edk2 > > > $ git submodule update --init > > > > I only said I reviewed it, not that the review was > > correct ;) > > > > Yeah, good catch. I just mentally filtered out the clone > > bit. > > > > > $ cd .. > > > > Why would you want to leave? > > Because the commands the follow are more clone commands for > edk2-platforms and edk2-non-osi. Could move the submodule > init action for the edk2 repo after all the clone operations. OK then :) / Leif > > > > > / > > Leif > > > > > Mike > > > > > > > -Original Message- > > > > From: Leif Lindholm [mailto:leif.lindh...@linaro.org] > > > > Sent: Wednesday, July 10, 2019 7:27 AM > > > > To: Wang, Jian J > > > > Cc: devel@edk2.groups.io; Kinney, Michael D > > > > ; Gao, Liming > > > > > > Subject: Re: [ PATCH v2 1/2] Readme.md: add submodule > > policy and > > > > clone commands > > > > > > > > On Wed, Jul 10, 2019 at 02:09:54PM +0800, Jian J Wang > > > > wrote: > > > > > > v2: update wording per Leif's and others' > > comments > > > > > > > > Please drop the above line - version comments can go > > below the --- > > > > line, so they don't get included in the commit > > message. > > > > > > > > With that: > > > > Reviewed-by: Leif Lindholm > > > > > > > > (although Liming had some further feedback) > > > > > > > > > REF: > > > > https://bugzilla.tianocore.org/show_bug.cgi?id=1910 > > > > > > > > > > A section 'Submodules' is added to clarify the > > > > submodule policy in > > > > > edk2 repo. Git commands are also added to show the > > > > correct way to > > > > > clone submodule repos, in which '--recursive' is > > > > removed because it's > > > > > not needed but recommended in other document. > > > > > > > > > > Related commits: > > > > > Openssl-1.1.1b upgrade: > > > > acfb90911840c38a0beb9bcfe0065668244d2b4d > > > > > berkeley-softfloat-3: > > > > 3cc57695df5a6e8c65fb46b993836c315cabf49d > > > > > > > > > > Cc: Leif Lindholm > > > > > Cc: Michael D Kinney > > > > > Cc: Liming Gao > > > > > Signed-off-by: Jian J Wang > > > > > --- > > > > > Readme.md | 28 > > > > > 1 file changed, 28 insertions(+) > > > > > > > > > > diff --git a/Readme.md b/Readme.md index > > e564c6c09b..c475468655 > > > > > 100644 > > > > > --- a/Readme.md > > > > > +++ b/Readme.md > > > > > @@ -143,3 +143,31 @@ Signed-off-by: Contributor > > Name > > > > > > > > >the change. Each line should be less than ~70 > > > > characters. > > > > > * `Signed-off-by` is the contributor's signature > > > > identifying them > > > > >by their real/legal name and their email > > address. > > > > > + > > > > > +# Submodules > > > > > + > > > > > +As a general policy, submodule chain should be > > avoided > > > > in EDK II repo > > > > > +as possible as we can. Currently EDK II contains > > two > > > > submodules > > > > > + > > > > > +- CryptoPkg/Library/OpensslLib/openssl > > > > > +- ArmPkg/Library/ArmSoftFloatLib/berkeley- > > softfloat-3 > > > > > + > > > > > +The latter one is actually required by previous > > one. > > > > It's inevitable > > > > > +in openssl-1.1.1 (since stable201905) for floating > > > > point parameter > > > > > +conversion, but should be dropped once there's no > > such > > > > need in future > > > > > +release of openssl. > > > > > + > > > > > +To get a full, buildable EDK II repository, use > > > > following two steps > > > > > +of git command > > > > > + > > > > > +``` > > > > > +$ git clone https://github.com/tianocore/edk2.git > > > > > +$ git submodule update --init> > +``` > > > > > + > > > > > +Note: When cloning submodule repos, '--recursive' > > > > option is not > > > > > +recommended. EDK II itself will not use any > > > > code/feature from > > > > > +submodules in above submodules. So using '-- > > recursive' > > > > adds a > > > > > +dependency on being able to reach servers we do > > not > > > > actually want any > > > > > +code from, as well as needlessly downloading code > > we > > > > will not use. > > > > > -- > > > > > 2.17.1.windows.2 > > > > > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#43493): https://edk2.groups.io/g/devel/message/43493 Mute This Topic: https://gro
Re: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands
> -Original Message- > From: Leif Lindholm [mailto:leif.lindh...@linaro.org] > Sent: Wednesday, July 10, 2019 10:18 AM > To: Kinney, Michael D > Cc: Wang, Jian J ; > devel@edk2.groups.io; Gao, Liming > Subject: Re: [ PATCH v2 1/2] Readme.md: add submodule > policy and clone commands > > On Wed, Jul 10, 2019 at 05:08:32PM +, Kinney, Michael > D wrote: > > Leif, > > > > I think the following command has to be run from the > git dir that the > > edk2 repo was cloned into. > > > > $ git submodule update --init > > > > So I think the correct instructions would be: > > > > $ git clone https://github.com/tianocore/edk2.git > > $ cd edk2 > > $ git submodule update --init > > I only said I reviewed it, not that the review was > correct ;) > > Yeah, good catch. I just mentally filtered out the clone > bit. > > > $ cd .. > > Why would you want to leave? Because the commands the follow are more clone commands for edk2-platforms and edk2-non-osi. Could move the submodule init action for the edk2 repo after all the clone operations. > > / > Leif > > > Mike > > > > > -Original Message- > > > From: Leif Lindholm [mailto:leif.lindh...@linaro.org] > > > Sent: Wednesday, July 10, 2019 7:27 AM > > > To: Wang, Jian J > > > Cc: devel@edk2.groups.io; Kinney, Michael D > > > ; Gao, Liming > > > > Subject: Re: [ PATCH v2 1/2] Readme.md: add submodule > policy and > > > clone commands > > > > > > On Wed, Jul 10, 2019 at 02:09:54PM +0800, Jian J Wang > > > wrote: > > > > > v2: update wording per Leif's and others' > comments > > > > > > Please drop the above line - version comments can go > below the --- > > > line, so they don't get included in the commit > message. > > > > > > With that: > > > Reviewed-by: Leif Lindholm > > > > > > (although Liming had some further feedback) > > > > > > > REF: > > > https://bugzilla.tianocore.org/show_bug.cgi?id=1910 > > > > > > > > A section 'Submodules' is added to clarify the > > > submodule policy in > > > > edk2 repo. Git commands are also added to show the > > > correct way to > > > > clone submodule repos, in which '--recursive' is > > > removed because it's > > > > not needed but recommended in other document. > > > > > > > > Related commits: > > > > Openssl-1.1.1b upgrade: > > > acfb90911840c38a0beb9bcfe0065668244d2b4d > > > > berkeley-softfloat-3: > > > 3cc57695df5a6e8c65fb46b993836c315cabf49d > > > > > > > > Cc: Leif Lindholm > > > > Cc: Michael D Kinney > > > > Cc: Liming Gao > > > > Signed-off-by: Jian J Wang > > > > --- > > > > Readme.md | 28 > > > > 1 file changed, 28 insertions(+) > > > > > > > > diff --git a/Readme.md b/Readme.md index > e564c6c09b..c475468655 > > > > 100644 > > > > --- a/Readme.md > > > > +++ b/Readme.md > > > > @@ -143,3 +143,31 @@ Signed-off-by: Contributor > Name > > > > > > >the change. Each line should be less than ~70 > > > characters. > > > > * `Signed-off-by` is the contributor's signature > > > identifying them > > > >by their real/legal name and their email > address. > > > > + > > > > +# Submodules > > > > + > > > > +As a general policy, submodule chain should be > avoided > > > in EDK II repo > > > > +as possible as we can. Currently EDK II contains > two > > > submodules > > > > + > > > > +- CryptoPkg/Library/OpensslLib/openssl > > > > +- ArmPkg/Library/ArmSoftFloatLib/berkeley- > softfloat-3 > > > > + > > > > +The latter one is actually required by previous > one. > > > It's inevitable > > > > +in openssl-1.1.1 (since stable201905) for floating > > > point parameter > > > > +conversion, but should be dropped once there's no > such > > > need in future > > > > +release of openssl. > > > > + > > > > +To get a full, buildable EDK II repository, use > > > following two steps > > > > +of git command > > > > + > > > > +``` > > > > +$ git clone https://github.com/tianocore/edk2.git > > > > +$ git submodule update --init> > +``` > > > > + > > > > +Note: When cloning submodule repos, '--recursive' > > > option is not > > > > +recommended. EDK II itself will not use any > > > code/feature from > > > > +submodules in above submodules. So using '-- > recursive' > > > adds a > > > > +dependency on being able to reach servers we do > not > > > actually want any > > > > +code from, as well as needlessly downloading code > we > > > will not use. > > > > -- > > > > 2.17.1.windows.2 > > > > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#43492): https://edk2.groups.io/g/devel/message/43492 Mute This Topic: https://groups.io/mt/32413655/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands
On Wed, Jul 10, 2019 at 05:08:32PM +, Kinney, Michael D wrote: > Leif, > > I think the following command has to be run from the git > dir that the edk2 repo was cloned into. > > $ git submodule update --init > > So I think the correct instructions would be: > > $ git clone https://github.com/tianocore/edk2.git > $ cd edk2 > $ git submodule update --init I only said I reviewed it, not that the review was correct ;) Yeah, good catch. I just mentally filtered out the clone bit. > $ cd .. Why would you want to leave? / Leif > Mike > > > -Original Message- > > From: Leif Lindholm [mailto:leif.lindh...@linaro.org] > > Sent: Wednesday, July 10, 2019 7:27 AM > > To: Wang, Jian J > > Cc: devel@edk2.groups.io; Kinney, Michael D > > ; Gao, Liming > > > > Subject: Re: [ PATCH v2 1/2] Readme.md: add submodule > > policy and clone commands > > > > On Wed, Jul 10, 2019 at 02:09:54PM +0800, Jian J Wang > > wrote: > > > > v2: update wording per Leif's and others' comments > > > > Please drop the above line - version comments can go > > below the --- line, so they don't get included in the > > commit message. > > > > With that: > > Reviewed-by: Leif Lindholm > > > > (although Liming had some further feedback) > > > > > REF: > > https://bugzilla.tianocore.org/show_bug.cgi?id=1910 > > > > > > A section 'Submodules' is added to clarify the > > submodule policy in > > > edk2 repo. Git commands are also added to show the > > correct way to > > > clone submodule repos, in which '--recursive' is > > removed because it's > > > not needed but recommended in other document. > > > > > > Related commits: > > > Openssl-1.1.1b upgrade: > > acfb90911840c38a0beb9bcfe0065668244d2b4d > > > berkeley-softfloat-3: > > 3cc57695df5a6e8c65fb46b993836c315cabf49d > > > > > > Cc: Leif Lindholm > > > Cc: Michael D Kinney > > > Cc: Liming Gao > > > Signed-off-by: Jian J Wang > > > --- > > > Readme.md | 28 > > > 1 file changed, 28 insertions(+) > > > > > > diff --git a/Readme.md b/Readme.md > > > index e564c6c09b..c475468655 100644 > > > --- a/Readme.md > > > +++ b/Readme.md > > > @@ -143,3 +143,31 @@ Signed-off-by: Contributor Name > > > > >the change. Each line should be less than ~70 > > characters. > > > * `Signed-off-by` is the contributor's signature > > identifying them > > >by their real/legal name and their email address. > > > + > > > +# Submodules > > > + > > > +As a general policy, submodule chain should be avoided > > in EDK II repo > > > +as possible as we can. Currently EDK II contains two > > submodules > > > + > > > +- CryptoPkg/Library/OpensslLib/openssl > > > +- ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3 > > > + > > > +The latter one is actually required by previous one. > > It's inevitable > > > +in openssl-1.1.1 (since stable201905) for floating > > point parameter > > > +conversion, but should be dropped once there's no such > > need in future > > > +release of openssl. > > > + > > > +To get a full, buildable EDK II repository, use > > following two steps > > > +of git command > > > + > > > +``` > > > +$ git clone https://github.com/tianocore/edk2.git > > > +$ git submodule update --init> > +``` > > > + > > > +Note: When cloning submodule repos, '--recursive' > > option is not > > > +recommended. EDK II itself will not use any > > code/feature from > > > +submodules in above submodules. So using '--recursive' > > adds a > > > +dependency on being able to reach servers we do not > > actually want any > > > +code from, as well as needlessly downloading code we > > will not use. > > > -- > > > 2.17.1.windows.2 > > > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#43491): https://edk2.groups.io/g/devel/message/43491 Mute This Topic: https://groups.io/mt/32413655/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands
Leif, I think the following command has to be run from the git dir that the edk2 repo was cloned into. $ git submodule update --init So I think the correct instructions would be: $ git clone https://github.com/tianocore/edk2.git $ cd edk2 $ git submodule update --init $ cd .. Mike > -Original Message- > From: Leif Lindholm [mailto:leif.lindh...@linaro.org] > Sent: Wednesday, July 10, 2019 7:27 AM > To: Wang, Jian J > Cc: devel@edk2.groups.io; Kinney, Michael D > ; Gao, Liming > > Subject: Re: [ PATCH v2 1/2] Readme.md: add submodule > policy and clone commands > > On Wed, Jul 10, 2019 at 02:09:54PM +0800, Jian J Wang > wrote: > > > v2: update wording per Leif's and others' comments > > Please drop the above line - version comments can go > below the --- line, so they don't get included in the > commit message. > > With that: > Reviewed-by: Leif Lindholm > > (although Liming had some further feedback) > > > REF: > https://bugzilla.tianocore.org/show_bug.cgi?id=1910 > > > > A section 'Submodules' is added to clarify the > submodule policy in > > edk2 repo. Git commands are also added to show the > correct way to > > clone submodule repos, in which '--recursive' is > removed because it's > > not needed but recommended in other document. > > > > Related commits: > > Openssl-1.1.1b upgrade: > acfb90911840c38a0beb9bcfe0065668244d2b4d > > berkeley-softfloat-3: > 3cc57695df5a6e8c65fb46b993836c315cabf49d > > > > Cc: Leif Lindholm > > Cc: Michael D Kinney > > Cc: Liming Gao > > Signed-off-by: Jian J Wang > > --- > > Readme.md | 28 > > 1 file changed, 28 insertions(+) > > > > diff --git a/Readme.md b/Readme.md > > index e564c6c09b..c475468655 100644 > > --- a/Readme.md > > +++ b/Readme.md > > @@ -143,3 +143,31 @@ Signed-off-by: Contributor Name > > >the change. Each line should be less than ~70 > characters. > > * `Signed-off-by` is the contributor's signature > identifying them > >by their real/legal name and their email address. > > + > > +# Submodules > > + > > +As a general policy, submodule chain should be avoided > in EDK II repo > > +as possible as we can. Currently EDK II contains two > submodules > > + > > +- CryptoPkg/Library/OpensslLib/openssl > > +- ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3 > > + > > +The latter one is actually required by previous one. > It's inevitable > > +in openssl-1.1.1 (since stable201905) for floating > point parameter > > +conversion, but should be dropped once there's no such > need in future > > +release of openssl. > > + > > +To get a full, buildable EDK II repository, use > following two steps > > +of git command > > + > > +``` > > +$ git clone https://github.com/tianocore/edk2.git > > +$ git submodule update --init> > +``` > > + > > +Note: When cloning submodule repos, '--recursive' > option is not > > +recommended. EDK II itself will not use any > code/feature from > > +submodules in above submodules. So using '--recursive' > adds a > > +dependency on being able to reach servers we do not > actually want any > > +code from, as well as needlessly downloading code we > will not use. > > -- > > 2.17.1.windows.2 > > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#43488): https://edk2.groups.io/g/devel/message/43488 Mute This Topic: https://groups.io/mt/32413655/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands
On Wed, Jul 10, 2019 at 02:09:54PM +0800, Jian J Wang wrote: > > v2: update wording per Leif's and others' comments Please drop the above line - version comments can go below the --- line, so they don't get included in the commit message. With that: Reviewed-by: Leif Lindholm (although Liming had some further feedback) > REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1910 > > A section 'Submodules' is added to clarify the submodule policy > in edk2 repo. Git commands are also added to show the correct > way to clone submodule repos, in which '--recursive' is removed > because it's not needed but recommended in other document. > > Related commits: > Openssl-1.1.1b upgrade: acfb90911840c38a0beb9bcfe0065668244d2b4d > berkeley-softfloat-3: 3cc57695df5a6e8c65fb46b993836c315cabf49d > > Cc: Leif Lindholm > Cc: Michael D Kinney > Cc: Liming Gao > Signed-off-by: Jian J Wang > --- > Readme.md | 28 > 1 file changed, 28 insertions(+) > > diff --git a/Readme.md b/Readme.md > index e564c6c09b..c475468655 100644 > --- a/Readme.md > +++ b/Readme.md > @@ -143,3 +143,31 @@ Signed-off-by: Contributor Name >the change. Each line should be less than ~70 characters. > * `Signed-off-by` is the contributor's signature identifying them >by their real/legal name and their email address. > + > +# Submodules > + > +As a general policy, submodule chain should be avoided in EDK II repo > +as possible as we can. Currently EDK II contains two submodules > + > +- CryptoPkg/Library/OpensslLib/openssl > +- ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3 > + > +The latter one is actually required by previous one. It's inevitable > +in openssl-1.1.1 (since stable201905) for floating point parameter > +conversion, but should be dropped once there's no such need in future > +release of openssl. > + > +To get a full, buildable EDK II repository, use following two steps > +of git command > + > +``` > +$ git clone https://github.com/tianocore/edk2.git > +$ git submodule update --init > +``` > + > +Note: When cloning submodule repos, '--recursive' option is not > +recommended. EDK II itself will not use any code/feature from > +submodules in above submodules. So using '--recursive' adds a > +dependency on being able to reach servers we do not actually want > +any code from, as well as needlessly downloading code we will not > +use. > -- > 2.17.1.windows.2 > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#43482): https://edk2.groups.io/g/devel/message/43482 Mute This Topic: https://groups.io/mt/32413655/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands
Jian: >-Original Message- >From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of >Wang, Jian J >Sent: Wednesday, July 10, 2019 2:10 PM >To: devel@edk2.groups.io >Cc: Leif Lindholm ; Kinney, Michael D >; Gao, Liming >Subject: [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule policy and >clone commands > >> v2: update wording per Leif's and others' comments > >REF: https://bugzilla.tianocore.org/show_bug.cgi?id=1910 > >A section 'Submodules' is added to clarify the submodule policy >in edk2 repo. Git commands are also added to show the correct >way to clone submodule repos, in which '--recursive' is removed >because it's not needed but recommended in other document. > >Related commits: >Openssl-1.1.1b upgrade: acfb90911840c38a0beb9bcfe0065668244d2b4d >berkeley-softfloat-3: 3cc57695df5a6e8c65fb46b993836c315cabf49d > >Cc: Leif Lindholm >Cc: Michael D Kinney >Cc: Liming Gao >Signed-off-by: Jian J Wang >--- > Readme.md | 28 > 1 file changed, 28 insertions(+) > >diff --git a/Readme.md b/Readme.md >index e564c6c09b..c475468655 100644 >--- a/Readme.md >+++ b/Readme.md >@@ -143,3 +143,31 @@ Signed-off-by: Contributor Name > > the change. Each line should be less than ~70 characters. > * `Signed-off-by` is the contributor's signature identifying them > by their real/legal name and their email address. >+ >+# Submodules >+ >+As a general policy, submodule chain should be avoided in EDK II repo >+as possible as we can. Currently EDK II contains two submodules Here, I understand to avoid the child submodule, and the root submodule is allowed. Besides, there is two spaces between EDK II contains. Please take care. >+ >+- CryptoPkg/Library/OpensslLib/openssl >+- ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3 >+ >+The latter one is actually required by previous one. It's inevitable >+in openssl-1.1.1 (since stable201905) for floating point parameter >+conversion, but should be dropped once there's no such need in future >+release of openssl. >+ >+To get a full, buildable EDK II repository, use following two steps >+of git command >+ >+``` >+$ git clone https://github.com/tianocore/edk2.git >+$ git submodule update --init >+``` >+ Please also give the update command for submodule. Thanks Liming >+Note: When cloning submodule repos, '--recursive' option is not >+recommended. EDK II itself will not use any code/feature from >+submodules in above submodules. So using '--recursive' adds a >+dependency on being able to reach servers we do not actually want >+any code from, as well as needlessly downloading code we will not >+use. >-- >2.17.1.windows.2 > > > -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#43460): https://edk2.groups.io/g/devel/message/43460 Mute This Topic: https://groups.io/mt/32413655/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
