Re: [PATCH v2 1/3] ProcessorPkg/RiscVOpensbLib: Add opensbi submodule

["Leif Lindholm" <leif@nuviainc.com>]

On Fri, May 15, 2020 at 15:39:35 +0200, Daniel Schaefer wrote:
> Add submodule opensbi under
> Silicon/RISC-V/ProcessorPkg/Library/RiscVOpensbLlib.
> The current supported opensbi version for RISC-V edk2 port is tags/v0.6.
> 
> Signed-off-by: Daniel Schaefer <daniel.schaefer@hpe.com>
> Co-authored-by: Gilbert Chen <gilbert.chen@hpe.com>
> Co-authored-by: Abner Chang <abner.chang@hpe.com>

Please drop the above two lines.
>From a project standpoint they are no-ops and I don't really mind
keeping them in 2-3/3 (I appreciate the sentiment), but this patch
isn't interesting enough to justify it, and mainly duplicates/modifies
content already in edk2/ReadMe.rst.

With that:
Reviewed-by: Leif Lindholm <leif@nuviainc.com>

> 
> Cc: Abner Chang <abner.chang@hpe.com>
> Cc: Gilbert Chen <gilbert.chen@hpe.com>
> Cc: Michael D Kinney <michael.k.kinney@intel.com>
> Cc: Leif Lindholm <leif@nuviainc.com>
> ---
>  .gitmodules                                                 |  3 ++
>  Readme.md                                                   | 36 ++++++++++++++++++++
>  Silicon/RISC-V/ProcessorPkg/Library/RiscVOpensbiLib/opensbi |  1 +
>  3 files changed, 40 insertions(+)
> 
> diff --git a/.gitmodules b/.gitmodules
> new file mode 100644
> index 000000000000..88aafaf15820
> --- /dev/null
> +++ b/.gitmodules
> @@ -0,0 +1,3 @@
> +[submodule "Silicon/RISC-V/ProcessorPkg/Library/RiscVOpensbiLib/opensbi"]
> +  path = Silicon/RISC-V/ProcessorPkg/Library/RiscVOpensbiLib/opensbi
> +  url = https://github.com/riscv/opensbi
> diff --git a/Readme.md b/Readme.md
> index 8f9522659d7b..8f7317e6b029 100644
> --- a/Readme.md
> +++ b/Readme.md
> @@ -10,6 +10,10 @@ The majority of the content in the EDK II open source project uses a
>  [BSD-2-Clause Plus Patent License](License.txt).  Additional details on EDK II
>  open source project code contributions can be found in the edk2 repository
>  [Readme.md](https://github.com/tianocore/edk2/blob/master/Readme.md).
> +The EDK II Platforms open source project contains the following components that
> +are covered by additional licenses:
> +
> +- [`Silicon/RISC-V/ProcessorPkg/Library/RiscVOpensbiLib/opensbi`](https://github.com/riscv/opensbi/blob/master/COPYING.BSD)
>  
>  # INDEX
>  * [Overview](#overview)
> @@ -260,3 +264,35 @@ For more information, see the
>  # Maintainers
>  
>  See [Maintainers.txt](Maintainers.txt).
> +
> +# Submodules
> +
> +Submodule in EDK II Platforms is allowed but submodule chain should be avoided
> +as possible as we can. Currently EDK II Platforms contains the following
> +submodules
> +
> +- Silicon/RISC-V/ProcessorPkg/Library/RiscVOpensbiLib/opensbi
> +
> +To get a full, buildable EDK II repository, use following steps of git command
> +
> +```bash
> +  git clone https://github.com/tianocore/edk2-platforms.git
> +  cd edk2-platforms
> +  git submodule update --init
> +  cd ..
> +```
> +
> +If there's update for submodules, use following git commands to get the latest
> +submodules code.
> +
> +```bash
> +  cd edk2-platforms
> +  git pull
> +  git submodule update
> +```
> +
> +Note: When cloning submodule repos, '--recursive' option is not recommended.
> +EDK II Platforms 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.
> diff --git a/Silicon/RISC-V/ProcessorPkg/Library/RiscVOpensbiLib/opensbi b/Silicon/RISC-V/ProcessorPkg/Library/RiscVOpensbiLib/opensbi
> new file mode 160000
> index 000000000000..ac5e821d50be
> --- /dev/null
> +++ b/Silicon/RISC-V/ProcessorPkg/Library/RiscVOpensbiLib/opensbi
> @@ -0,0 +1 @@
> +Subproject commit ac5e821d50be631f26274765a59bc1b444ffd862
> -- 
> 2.26.1
>