[Patch V2] edk2: Update additional licenses in Readme.md

[Patch V2] edk2: Update additional licenses in Readme.md

[Michael D Kinney]

Update the list of additional licenses in Readme.md.  For additional
licenses from a git submodule, provide a link to the license file
in the remote git repository.  This makes the links in Readme.md
when viewed from the edk2 repository GitHub landing page
https://github.com/tianocore/edk2/ functional from a web browser.

* Remove references EdkCompatibilityPkg
* Update link to OpenSSL to license file in the git submodule link
  to https://github.com/openssl/openssl
* Add link to license file in the git submodule like to
  https://github.com/ucb-bar/berkeley-softfloat-3 for
  ArmSoftFloatLib

Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
---
 Readme.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Readme.md b/Readme.md
index 1feba16075..567efe9abc 100644
--- a/Readme.md
+++ b/Readme.md
@@ -12,10 +12,10 @@ contains the following components that are covered by additional licenses:
 * [MdeModulePkg/Library/LzmaCustomDecompressLib](MdeModulePkg/Library/LzmaCustomDecompressLib/LZMA-SDK-README.txt)
 * [IntelFrameworkModulePkg/Library/LzmaCustomDecompressLib/Sdk](IntelFrameworkModulePkg/Library/LzmaCustomDecompressLib/LZMA-SDK-README.txt)
 * [BaseTools/Source/C/VfrCompile/Pccts](BaseTools/Source/C/VfrCompile/Pccts/RIGHTS)
-* [EdkCompatibilityPkg/Other/Maintained/Tools/Pccts](EdkCompatibilityPkg/Other/Maintained/Tools/Pccts/README)
 * [MdeModulePkg/Universal/RegularExpressionDxe/Oniguruma](MdeModulePkg/Universal/RegularExpressionDxe/Oniguruma/README)
 * [OvmfPkg](OvmfPkg/License.txt)
-* [CryptoPkg/Library/OpensslLib/openssl](CryptoPkg/Library/OpensslLib/openssl/LICENSE)
+* [CryptoPkg/Library/OpensslLib/openssl](https://github.com/openssl/openssl/blob/151333164ece49fdba3fe5c4bbdc3333cd9ae66d/LICENSE)
+* [ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3](https://github.com/ucb-bar/berkeley-softfloat-3/blob/f74b1e48110ac3a27dd49b787d164e55e42d81d1/COPYING.txt)
 
 The EDK II Project is composed of packages.  The maintainers for each package
 are listed in [Maintainers.txt](Maintainers.txt).
-- 
2.21.0.windows.1

Re: [edk2-devel] [Patch V2] edk2: Update additional licenses in Readme.md

[Laszlo Ersek]

Hi Mike,

On 06/04/19 20:40, Michael D Kinney wrote:
> Update the list of additional licenses in Readme.md.  For additional
> licenses from a git submodule, provide a link to the license file
> in the remote git repository.  This makes the links in Readme.md
> when viewed from the edk2 repository GitHub landing page
> https://github.com/tianocore/edk2/ functional from a web browser.
> 
> * Remove references EdkCompatibilityPkg
> * Update link to OpenSSL to license file in the git submodule link
>   to https://github.com/openssl/openssl
> * Add link to license file in the git submodule like to
>   https://github.com/ucb-bar/berkeley-softfloat-3 for
>   ArmSoftFloatLib
> 
> Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
> Reviewed-by: Laszlo Ersek <lersek@redhat.com>
> ---
>  Readme.md | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Readme.md b/Readme.md
> index 1feba16075..567efe9abc 100644
> --- a/Readme.md
> +++ b/Readme.md
> @@ -12,10 +12,10 @@ contains the following components that are covered by additional licenses:
>  * [MdeModulePkg/Library/LzmaCustomDecompressLib](MdeModulePkg/Library/LzmaCustomDecompressLib/LZMA-SDK-README.txt)
>  * [IntelFrameworkModulePkg/Library/LzmaCustomDecompressLib/Sdk](IntelFrameworkModulePkg/Library/LzmaCustomDecompressLib/LZMA-SDK-README.txt)
>  * [BaseTools/Source/C/VfrCompile/Pccts](BaseTools/Source/C/VfrCompile/Pccts/RIGHTS)
> -* [EdkCompatibilityPkg/Other/Maintained/Tools/Pccts](EdkCompatibilityPkg/Other/Maintained/Tools/Pccts/README)
>  * [MdeModulePkg/Universal/RegularExpressionDxe/Oniguruma](MdeModulePkg/Universal/RegularExpressionDxe/Oniguruma/README)
>  * [OvmfPkg](OvmfPkg/License.txt)
> -* [CryptoPkg/Library/OpensslLib/openssl](CryptoPkg/Library/OpensslLib/openssl/LICENSE)
> +* [CryptoPkg/Library/OpensslLib/openssl](https://github.com/openssl/openssl/blob/151333164ece49fdba3fe5c4bbdc3333cd9ae66d/LICENSE)
> +* [ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3](https://github.com/ucb-bar/berkeley-softfloat-3/blob/f74b1e48110ac3a27dd49b787d164e55e42d81d1/COPYING.txt)
>  
>  The EDK II Project is composed of packages.  The maintainers for each package
>  are listed in [Maintainers.txt](Maintainers.txt).
> 

The submodule commit hashes captured in the links do not seem to match our submodule references (at this point in time). With the master branch @ 7cea4d71a8a8, we have:

$ git submodule status
 b64af41c3276f97f0e181920400ee056b9c88037 ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3 (heads/master)
 50eaac9f3337667259de725451f201e784599687 CryptoPkg/Library/OpensslLib/openssl (OpenSSL_1_1_1b)

IMO, these are the commit hashes that we should include in the URLs. I suggest constructing the URLs manually, given the commit hashes, and the general structure of the URL.

https://github.com/openssl/openssl/blob/50eaac9f3337667259de725451f201e784599687/LICENSE
https://github.com/ucb-bar/berkeley-softfloat-3/blob/b64af41c3276f97f0e181920400ee056b9c88037/COPYING.txt

Thanks
Laszlo

Re: [edk2-devel] [Patch V2] edk2: Update additional licenses in Readme.md

[Michael D Kinney]

Thanks Laszlo.  I will send a V3 with the updated links.

Mike

> -----Original Message-----
> From: devel@edk2.groups.io [mailto:devel@edk2.groups.io]
> On Behalf Of Laszlo Ersek
> Sent: Tuesday, June 4, 2019 11:58 AM
> To: devel@edk2.groups.io; Kinney, Michael D
> <michael.d.kinney@intel.com>
> Subject: Re: [edk2-devel] [Patch V2] edk2: Update
> additional licenses in Readme.md
> 
> Hi Mike,
> 
> On 06/04/19 20:40, Michael D Kinney wrote:
> > Update the list of additional licenses in Readme.md.
> For additional
> > licenses from a git submodule, provide a link to the
> license file in
> > the remote git repository.  This makes the links in
> Readme.md when
> > viewed from the edk2 repository GitHub landing page
> > https://github.com/tianocore/edk2/ functional from a
> web browser.
> >
> > * Remove references EdkCompatibilityPkg
> > * Update link to OpenSSL to license file in the git
> submodule link
> >   to https://github.com/openssl/openssl
> > * Add link to license file in the git submodule like
> to
> >   https://github.com/ucb-bar/berkeley-softfloat-3 for
> >   ArmSoftFloatLib
> >
> > Signed-off-by: Michael D Kinney
> <michael.d.kinney@intel.com>
> > Reviewed-by: Laszlo Ersek <lersek@redhat.com>
> > ---
> >  Readme.md | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/Readme.md b/Readme.md
> > index 1feba16075..567efe9abc 100644
> > --- a/Readme.md
> > +++ b/Readme.md
> > @@ -12,10 +12,10 @@ contains the following components
> that are covered by additional licenses:
> >  *
> >
> [MdeModulePkg/Library/LzmaCustomDecompressLib](MdeModule
> Pkg/Library/Lz
> > maCustomDecompressLib/LZMA-SDK-README.txt)
> >  *
> >
> [IntelFrameworkModulePkg/Library/LzmaCustomDecompressLib
> /Sdk](IntelFra
> > meworkModulePkg/Library/LzmaCustomDecompressLib/LZMA-
> SDK-README.txt)
> >  *
> >
> [BaseTools/Source/C/VfrCompile/Pccts](BaseTools/Source/C
> /VfrCompile/Pc
> > cts/RIGHTS)
> > -*
> >
> [EdkCompatibilityPkg/Other/Maintained/Tools/Pccts](EdkCo
> mpatibilityPkg
> > /Other/Maintained/Tools/Pccts/README)
> >  *
> >
> [MdeModulePkg/Universal/RegularExpressionDxe/Oniguruma](
> MdeModulePkg/U
> > niversal/RegularExpressionDxe/Oniguruma/README)
> >  * [OvmfPkg](OvmfPkg/License.txt)
> > -*
> >
> [CryptoPkg/Library/OpensslLib/openssl](CryptoPkg/Library
> /OpensslLib/op
> > enssl/LICENSE)
> > +*
> >
> +[CryptoPkg/Library/OpensslLib/openssl](https://github.c
> om/openssl/ope
> >
> +nssl/blob/151333164ece49fdba3fe5c4bbdc3333cd9ae66d/LICE
> NSE)
> > +*
> > +[ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-
> 3](https://github.
> > +com/ucb-bar/berkeley-softfloat-
> 3/blob/f74b1e48110ac3a27dd49b787d164e5
> > +5e42d81d1/COPYING.txt)
> >
> >  The EDK II Project is composed of packages.  The
> maintainers for each
> > package  are listed in
> [Maintainers.txt](Maintainers.txt).
> >
> 
> The submodule commit hashes captured in the links do not
> seem to match our submodule references (at this point in
> time). With the master branch @ 7cea4d71a8a8, we have:
> 
> $ git submodule status
>  b64af41c3276f97f0e181920400ee056b9c88037
> ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3
> (heads/master)
>  50eaac9f3337667259de725451f201e784599687
> CryptoPkg/Library/OpensslLib/openssl (OpenSSL_1_1_1b)
> 
> IMO, these are the commit hashes that we should include
> in the URLs. I suggest constructing the URLs manually,
> given the commit hashes, and the general structure of
> the URL.
> 
> https://github.com/openssl/openssl/blob/50eaac9f33376672
> 59de725451f201e784599687/LICENSE
> https://github.com/ucb-bar/berkeley-softfloat-
> 3/blob/b64af41c3276f97f0e181920400ee056b9c88037/COPYING.
> txt
> 
> Thanks
> Laszlo
> 
>