public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Wang, Jian J" <jian.j.wang@intel.com>
To: devel@edk2.groups.io
Cc: Leif Lindholm <leif.lindholm@linaro.org>,
	Michael D Kinney <michael.d.kinney@intel.com>,
	Liming Gao <liming.gao@intel.com>
Subject: [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands
Date: Wed, 10 Jul 2019 14:09:54 +0800	[thread overview]
Message-ID: <20190710060955.7672-2-jian.j.wang@intel.com> (raw)
In-Reply-To: <20190710060955.7672-1-jian.j.wang@intel.com>

> 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 <leif.lindholm@linaro.org>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Jian J Wang <jian.j.wang@intel.com>
---
 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 <contributor@example.com>
   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


  reply	other threads:[~2019-07-10  6:09 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-07-10  6:09 [ PATCH v2 0/2] Add edk2 submodule policy Wang, Jian J
2019-07-10  6:09 ` Wang, Jian J [this message]
2019-07-10  7:43   ` [edk2-devel] [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands Liming Gao
2019-07-11  6:32     ` Wang, Jian J
2019-07-10 14:26   ` Leif Lindholm
2019-07-10 17:08     ` Michael D Kinney
2019-07-10 17:17       ` Leif Lindholm
2019-07-10 17:28         ` Michael D Kinney
2019-07-10 17:30           ` Leif Lindholm
2019-07-11  3:32           ` Wang, Jian J
2019-07-11 16:58         ` [off-topic] " Laszlo Ersek
2019-07-10  6:09 ` [ PATCH v2 2/2] CryptoPkg/OpensslLib: remove " Wang, Jian J

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190710060955.7672-2-jian.j.wang@intel.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox