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=Ex9vPXZ0; spf=pass (domain: linaro.org, ip: 209.85.221.65, mailfrom: leif.lindholm@linaro.org) Received: from mail-wr1-f65.google.com (mail-wr1-f65.google.com [209.85.221.65]) by groups.io with SMTP; Tue, 09 Jul 2019 02:26:38 -0700 Received: by mail-wr1-f65.google.com with SMTP id x4so20179557wrt.6 for ; Tue, 09 Jul 2019 02:26:37 -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=NkfQYwionngMQ5RcLyyF84EA+K3JrSl9Pn0eOM6oEu0=; b=Ex9vPXZ0Y47KVz4nqv/ImsNX79nvvOF20cpq6C29H/qA8yucAZotj1SIuT2kgbg+LR fctHPfniK7JSwVBGcDXdjV8LCn18uNCkZ4tTajq5drS8jNCrImqbfR62RyQBCGbgRM20 zWSpDQAPhJoG/2eoZR6ocYHvq1v5PU8pxcyo5LL70eNyZpSBp3FNF5uhhUoZmiX2S4Xt /r2B5sb1t5+DHNhC70UFx9UK0vslvZZ2tR4p7ale1qtXlapS3KaSd3kcfwowI7IOMppQ elqz/UL6CkuLe10s4BRmt694vEId5RB8fKlrFZR/yTJpM7Ed4Hd6sPdJLJpjaT2EHUR4 bdQA== 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=NkfQYwionngMQ5RcLyyF84EA+K3JrSl9Pn0eOM6oEu0=; b=krPwDlkKFsIyRMi8nNfADH51Z/VXXM3rg2lMdkpHKHR43qqauhuGa//S+B4qHzOkvZ juX923yaXp2YU5Pzw6fjs0pO4+wv+eHlLZ9sa9qgSekhf/udCNZe/YRrJpbRC+lpEj2a elqtEfbMLsUjTODPI3e/VODeLuX5wJlc6WIp18owdyeRlAakjRIssg8IrL+dPbq/yvIH AtrEthcTMJbCLJ+srXnF+uZEbPbNdiMZzOmDV6JOp2CfIqX1jV0ehT2+OJQh+GrzcIiR VPxO3nnl7wI3++4F3T+8ZGyqL+Wr4oN6iWEp4XyJVnoPklvf9dzCEPO0qzn45fD9TZ7o wVKw== X-Gm-Message-State: APjAAAW7NfwXK65Of9mGjhKFE3afbLCpZPHSsh21MYG534x6jbhENSQU 4K7N8irRtTbjvdY51XPl4t53DQ== X-Google-Smtp-Source: APXvYqzXnBq0x1ZHhyUA8UosjNsfAcXFNZNKxjdtDU/B1r8Pvv5uYfZaPKHhM2QsCnr2qlHOnJzlNQ== X-Received: by 2002:a5d:4108:: with SMTP id l8mr4529875wrp.113.1562664396380; Tue, 09 Jul 2019 02:26:36 -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 y16sm11536037wrw.33.2019.07.09.02.26.35 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Tue, 09 Jul 2019 02:26:35 -0700 (PDT) Date: Tue, 9 Jul 2019 10:26:34 +0100 From: "Leif Lindholm" To: Jian J Wang Cc: devel@edk2.groups.io, Michael D Kinney , Liming Gao Subject: Re: [PATCH 1/2] Readme.md: add submodule policy and clone commands Message-ID: <20190709092634.thwxpq6cw7u7tocp@bivouac.eciton.net> References: <20190709063601.7212-1-jian.j.wang@intel.com> <20190709063601.7212-2-jian.j.wang@intel.com> MIME-Version: 1.0 In-Reply-To: <20190709063601.7212-2-jian.j.wang@intel.com> User-Agent: NeoMutt/20170113 (1.7.2) Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Hi Jian, Many thanks for this. A few comments on the text. On Tue, Jul 09, 2019 at 02:36:00PM +0800, Jian J Wang wrote: > 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 | 19 +++++++++++++++++++ > 1 file changed, 19 insertions(+) > > diff --git a/Readme.md b/Readme.md > index e564c6c09b..ddb4da5648 100644 > --- a/Readme.md > +++ b/Readme.md > @@ -143,3 +143,22 @@ 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, submodules should be avoided in EDK II repo as possible as we can, especially submodules required by other submodules. Currently EDK II contains two submodules Please wrap lines at 80 characters. One of the benefits of markdown is that it can be easily read both as a plain text file, and be rendered into something else (like html for displaying on the web). > + > +- CryptoPkg/Library/OpensslLib/openssl > +- ArmPkg/Library/ArmSoftFloatLib/berkeley-softfloat-3 > + > +The later 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. "later" -> "latter" when referring to items in an enumeration (interesting quirk of English) > + > +Note: When cloning submodule repos, '--recursive' option is not recommended. EDK II itself will not use any code/feature from submodules in above submodules. '--recursive' might cause failure in cloning behind proxy. I wouldn't say "behind proxy". It may fail because it adds additional servers that must be reachable in order for the clone to succeed. So we could replace the last sentence above with something like: "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." I would also prefer to move this "Note:" to immediately below the command example: > + > +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:" here.) / Leif > -- > 2.17.1.windows.2 >