Re: [PATCH 1/3] edk2: jansson submodule of JSON library

["Laszlo Ersek" <lersek@redhat.com>]

On 11/23/20 14:47, Abner Chang wrote:
> Add jansson git submodule
> 
> Signed-off-by: Abner Chang <abner.chang@hpe.com>
> 
> Cc: Andrew Fish <afish@apple.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Cc: Leif Lindholm <leif@nuviainc.com>
> Cc: Michael D Kinney <michael.d.kinney@intel.com>
> Cc: Nickle Wang <nickle.wang@hpe.com>
> Cc: Peter O'Hanley <peter.ohanley@hpe.com>
> ---
>  .gitmodules                          | 3 +++
>  MdeModulePkg/Library/JsonLib/jansson | 1 +
>  ReadMe.rst                           | 1 +
>  3 files changed, 5 insertions(+)
>  create mode 160000 MdeModulePkg/Library/JsonLib/jansson
> 
> diff --git a/.gitmodules b/.gitmodules
> index c3a4e4aeca..77037b07b2 100644
> --- a/.gitmodules
> +++ b/.gitmodules
> @@ -17,3 +17,6 @@
>  	path = BaseTools/Source/C/BrotliCompress/brotli
>  	url = https://github.com/google/brotli
>  	ignore = untracked
> +[submodule "MdeModulePkg/Library/JsonLib/jansson"]
> +	path = MdeModulePkg/Library/JsonLib/jansson
> +	url = https://github.com/akheron/jansson
> diff --git a/MdeModulePkg/Library/JsonLib/jansson b/MdeModulePkg/Library/JsonLib/jansson
> new file mode 160000
> index 0000000000..e9ebfa7e77
> --- /dev/null
> +++ b/MdeModulePkg/Library/JsonLib/jansson
> @@ -0,0 +1 @@
> +Subproject commit e9ebfa7e77a6bee77df44e096b100e7131044059
> diff --git a/ReadMe.rst b/ReadMe.rst
> index c3c8178373..259739b5a3 100644
> --- a/ReadMe.rst
> +++ b/ReadMe.rst
> @@ -93,6 +93,7 @@ that are covered by additional licenses.
>  -  `MdeModulePkg/Library/BrotliCustomDecompressLib/brotli <https://github.com/google/brotli/blob/666c3280cc11dc433c303d79a83d4ffbdd12cc8d/LICENSE>`__
>  -  `MdeModulePkg/Universal/RegularExpressionDxe/oniguruma <https://github.com/kkos/oniguruma/blob/abfc8ff81df4067f309032467785e06975678f0d/COPYING>`__
>  -  `UnitTestFrameworkPkg/Library/CmockaLib/cmocka <https://git.cryptomilk.org/projects/cmocka.git/tree/COPYING?h=cmocka-1.1.5&id=f5e2cd77c88d9f792562888d2b70c5a396bfbf7a>`__
> +-  `MdeModulePkg/Library/JsonLib/jansson <https://github.com/akheron/jansson/blob/master/LICENSE>`__

(1) The link to the license file should not include a branch reference,
such as "master", given that "master" is a moving target, and if the
license of the subproject changes, we shouldn't silently advance to
that, even with a documentation link like the one above.

Instead, the link should point into the specific tree that our submodule
actually references (namely the tree at commit
e9ebfa7e77a6bee77df44e096b100e7131044059).

The right link for that seems to be:

https://github.com/akheron/jansson/blob/e9ebfa7e77a6bee77df44e096b100e7131044059/LICENSE

(2) The commit message is nearly useless. It should state what we need
the library for, and it should also highlight its license (MIT).


The rest is for the MdeModulePkg reviewers to check. You forgot to CC
them -- please use "BaseTools/Scripts/GetMaintainer.py".

Thanks
Laszlo


>  
>  The EDK II Project is composed of packages. The maintainers for each package
>  are listed in `Maintainers.txt <Maintainers.txt>`__.
>