From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mx.groups.io; dkim=pass header.i=@linaro.org header.s=google header.b=jqC+cKAT; spf=pass (domain: linaro.org, ip: 209.85.128.66, mailfrom: leif.lindholm@linaro.org) Received: from mail-wm1-f66.google.com (mail-wm1-f66.google.com [209.85.128.66]) by groups.io with SMTP; Wed, 10 Jul 2019 07:26:34 -0700 Received: by mail-wm1-f66.google.com with SMTP id v15so2557633wml.0 for ; Wed, 10 Jul 2019 07:26:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=pIFLUyLqrc+O/NlQFGOyQvsdIyDe99y+0M+bzic1QE0=; b=jqC+cKATK6YcmdOwfNPVPfg7GqSjPGXmVa1LDrRUp7MQWVGmHLx63lN5eAmmEdXEAe iuun0cN7UBZUYwWqFYmZkJHTdGsr1pcSchGEM7Y7lhZV00+GX4RtSK0P31bEcci3lYXd 9LuUtynkcq8Lh+K2fOXr5XIwDQyiTE+ej7A9+7j2IWO+3k8HezCCKFm34pXVQtLlSwvF nl6wLD/KUW2xiXrrVB+SUtyNc8c5HZVuGBu6U091JDdcWYVhqLRWD8mtCRIUHwFTqPoy UDcbVNm4m9pbhDadnvPfVPIGQtIHdTYSy1PVCuZ4TYnr4+nZed1PFzX8zq+xsG4kc6oB bA3g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=pIFLUyLqrc+O/NlQFGOyQvsdIyDe99y+0M+bzic1QE0=; b=oUV+wXjaz3R/7Ra1c5Bk2n5a4IVubJOTJT/ydPBD9aLj5Wfc9rK+RILGiCsLI+mb+H JxZQZBk0gZ/Xdu+TZqjJdzJiQe+6A4h8In9a7axCA+IxjArbcKSUywQA4OqeI+1GIUfU hM7F+lY0odisb1+YZV/HYyAfCLEwIhQCTxw4GRRTltMiTADZx1T5YN3zm3ou+TWwVdK4 1iGaaJWer3HqoX03xCC4XiQbWIap1VKXZ0JCwWIl90Jc3IRuKqTJ0S03twnq5nPHb3tx 67JV5Uhn/OrHj5AFCc0VL4eSgLg/04mwGxkr335WtYbcffJOP3P1IkiNPGvXMdVSHXXx N9Qg== X-Gm-Message-State: APjAAAWfLgas+bchvuLsjyL4CWqTYuBBqb9rF2w9Aktx+Cp5MKS5Wb57 j8YA4T0xg/13S3fuDMFlZKuCuQ== X-Google-Smtp-Source: APXvYqxQ14WEXchhIqrs7UKMx8l9tBk87rj8JMx6xkRndMTBLXMHMx9PTwSLji2mTn6lpTg5BNzITg== X-Received: by 2002:a7b:c4d0:: with SMTP id g16mr5883120wmk.88.1562768792312; Wed, 10 Jul 2019 07:26:32 -0700 (PDT) Return-Path: Received: from bivouac.eciton.net (bivouac.eciton.net. [2a00:1098:0:86:1000:23:0:2]) by smtp.gmail.com with ESMTPSA id z1sm2738427wrp.51.2019.07.10.07.26.31 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Wed, 10 Jul 2019 07:26:31 -0700 (PDT) Date: Wed, 10 Jul 2019 15:26:30 +0100 From: "Leif Lindholm" To: Jian J Wang Cc: devel@edk2.groups.io, Michael D Kinney , Liming Gao Subject: Re: [ PATCH v2 1/2] Readme.md: add submodule policy and clone commands Message-ID: <20190710142629.aomcdzwvapo34k6c@bivouac.eciton.net> References: <20190710060955.7672-1-jian.j.wang@intel.com> <20190710060955.7672-2-jian.j.wang@intel.com> MIME-Version: 1.0 In-Reply-To: <20190710060955.7672-2-jian.j.wang@intel.com> User-Agent: NeoMutt/20170113 (1.7.2) Content-Type: text/plain; charset=us-ascii Content-Disposition: inline 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 >