From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from linux.microsoft.com (linux.microsoft.com [13.77.154.182])
 by mx.groups.io with SMTP id smtpd.web10.74185.1670941054732806469
 for <devel@edk2.groups.io>;
 Tue, 13 Dec 2022 06:17:34 -0800
Authentication-Results: mx.groups.io;
 dkim=pass header.i=@linux.microsoft.com header.s=default header.b=AvTIEFgo;
 spf=pass (domain: linux.microsoft.com, ip: 13.77.154.182, mailfrom: mikuback@linux.microsoft.com)
Received: from [192.168.4.22] (unknown [47.201.8.94])
	by linux.microsoft.com (Postfix) with ESMTPSA id 58D6520B83EE;
	Tue, 13 Dec 2022 06:17:33 -0800 (PST)
DKIM-Filter: OpenDKIM Filter v2.11.0 linux.microsoft.com 58D6520B83EE
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.microsoft.com;
	s=default; t=1670941054;
	bh=zqWtlN49WfwhG90RkjcQGqyVjUEvfIN0Or5vGRvCp1Q=;
	h=Date:Subject:To:Cc:References:From:In-Reply-To:From;
	b=AvTIEFgoA0dfikcK2x0QdGuZtsSoKGnv+t2cib5aKDv74kJje7nhWWpPOA06Wuo5Y
	 xNiY5LsUUGFrNldocsbSIbXvYl4o+8u9sx9/gAZXD+/ZawZPwX6xfy3tEF+Pic8t27
	 aI5sK3/Dcg9cxvO60/0IL85KiSNaNZlXxXnj6YTw=
Message-ID: <7e4a78be-8898-b4e4-1447-92dabd25a317@linux.microsoft.com>
Date: Tue, 13 Dec 2022 09:17:31 -0500
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (Windows NT 6.2; Win64; x64; rv:91.0) Gecko/20100101
 Thunderbird/91.13.1
Subject: Re: [edk2-devel] [edk2-wiki][PATCH v3 1/4] Add initial How to Build with Stuart Document
To: Rebecca Cran <rebecca@bsdio.com>, devel@edk2.groups.io,
 quic_rcran@quicinc.com
Cc: Sean Brogan <sean.brogan@microsoft.com>,
 Michael D Kinney <michael.d.kinney@intel.com>,
 Liming Gao <gaoliming@byosoft.com.cn>
References: <20221207162403.337-1-mikuback@linux.microsoft.com>
 <20221207162403.337-2-mikuback@linux.microsoft.com>
 <e3bec8ba-18f8-fc40-7241-d3e90107e0cb@quicinc.com>
 <c47e517d-cac9-1a99-4d86-c355093385c4@linux.microsoft.com>
 <b1dcd940-e47b-1cb7-225e-4b4db1a9b32d@bsdio.com>
From: "Michael Kubacki" <mikuback@linux.microsoft.com>
In-Reply-To: <b1dcd940-e47b-1cb7-225e-4b4db1a9b32d@bsdio.com>
Content-Language: en-US
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit

On 12/13/2022 12:25 AM, Rebecca Cran wrote:
> According to 
> https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections, 
> it looks like normal markdown _should_ apply within collapsed sections?
> 
> 
It did not work consistently in some markdown previewers I was using 
locally and linking to sections was problematic. I did not spend a lot 
of time to force markdown because I don't mind HTML. It might be 
possible to convert if someone wants to do that.

> I noticed a few problems with 
> https://github.com/tianocore/tianocore.github.io/wiki/How-to-Build-With-Stuart 
> :
> 
> 
> Example: git clone edk2
> 
> Should probably be: git clone https://github.com/tianocore/edk2.git
> 
Thanks. This was a placeholder when writing that needed to be updated. 
Its updated now.
> 
> The Linux instructions for creating a python virtual environment should 
> probably be:
> 
> python3 -m venv .venv
> 
Changed python to python3.
> 
> Though I've been installing the stuart tools into ~/.local/bin which 
> allows you to skip the step of using a virtual environment.
> 
> 
> Lastly, the Git Submodules step says to use --recursive, which I seem to 
> recall other instructions suggesting _not_ to use, since it's not needed.
> 
I use it because there are nested submodules in edk2 such as those in 
CryptoPkg/Library/OpensslLib/openssl and I've run into problems in the 
past with its submodules not in sync.

Thanks,
Michael