Re: [edk2-devel] [edk2-wiki][PATCH v3 1/4] Add initial How to Build with Stuart Document

["Michael Kubacki" <mikuback@linux.microsoft.com>]

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