edk2-wiki: "How to build with Stuart" - suggested changes/additions

edk2-wiki: "How to build with Stuart" - suggested changes/additions

[Rebecca Cran]

Mike,


I tried following the "How to build with Stuart" document and ran into a 
some issues on my Ubuntu 20.04 system:


First, we now need to use "python3.9" on Ubuntu 20.04 since "python3" is 
3.8 which no longer works.


Secondly, the loongarch64 gcc download is 930MB - 3.2GB once unpacked. 
We might want to add something about specifying "-a LOONGARCH64" etc. if 
you want to build it, or '-a X64,AARCH64' etc. if you want to skip it. I 
ended up canceling "stuart_update" because I thought it had hung.


Lastly, the "stuart_update" command listed doesn't work: it seems you 
need to specify a TOOL_CHAIN_TAG to have it download anything.


-- 
Rebecca Cran

Re: [edk2-devel] edk2-wiki: "How to build with Stuart" - suggested changes/additions

[Michael D Kinney]

+ Michael Kubacki

> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Rebecca Cran
> Sent: Saturday, December 24, 2022 9:38 AM
> To: Kinney, Michael D <michael.d.kinney@intel.com>; devel@edk2.groups.io
> Subject: [edk2-devel] edk2-wiki: "How to build with Stuart" - suggested changes/additions
> 
> Mike,
> 
> 
> I tried following the "How to build with Stuart" document and ran into a
> some issues on my Ubuntu 20.04 system:
> 
> 
> First, we now need to use "python3.9" on Ubuntu 20.04 since "python3" is
> 3.8 which no longer works.
> 
> 
> Secondly, the loongarch64 gcc download is 930MB - 3.2GB once unpacked.
> We might want to add something about specifying "-a LOONGARCH64" etc. if
> you want to build it, or '-a X64,AARCH64' etc. if you want to skip it. I
> ended up canceling "stuart_update" because I thought it had hung.
> 
> 
> Lastly, the "stuart_update" command listed doesn't work: it seems you
> need to specify a TOOL_CHAIN_TAG to have it download anything.
> 
> 
> --
> Rebecca Cran
> 
> 
> 
> 
> 

Re: [edk2-devel] edk2-wiki: "How to build with Stuart" - suggested changes/additions

[Michael Kubacki]

Please feel free to send a wiki patch or directly make updates.

On 12/29/2022 12:41 PM, Michael D Kinney wrote:
> + Michael Kubacki
> 
>> -----Original Message-----
>> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Rebecca Cran
>> Sent: Saturday, December 24, 2022 9:38 AM
>> To: Kinney, Michael D <michael.d.kinney@intel.com>; devel@edk2.groups.io
>> Subject: [edk2-devel] edk2-wiki: "How to build with Stuart" - suggested changes/additions
>>
>> Mike,
>>
>>
>> I tried following the "How to build with Stuart" document and ran into a
>> some issues on my Ubuntu 20.04 system:
>>
>>
>> First, we now need to use "python3.9" on Ubuntu 20.04 since "python3" is
>> 3.8 which no longer works.
>>
I tried to avoid specifying exact versions where possible as they tend 
to get stale quickly. In a case like this, I lean toward pointing to a 
single location where we track the Python version supported and then 
provide a statement that says to use the python command for that version.

Though I'm fine with other approaches that best help people and can try 
to minimize likelihood of misinforming due to staleness over time.

>> Secondly, the loongarch64 gcc download is 930MB - 3.2GB once unpacked.
>> We might want to add something about specifying "-a LOONGARCH64" etc. if
>> you want to build it, or '-a X64,AARCH64' etc. if you want to skip it. I
>> ended up canceling "stuart_update" because I thought it had hung.
>>
You're right that the instructions do not directly mention the impact of 
the certain flags on the update process. I added that just now.

>> Lastly, the "stuart_update" command listed doesn't work: it seems you
>> need to specify a TOOL_CHAIN_TAG to have it download anything.
>>
You need to specify a tool chain tag to have it download tool chain 
specific binaries. It will download anything that has a scope set (like 
common binaries) irrespective of the tool chain tag. In some cases, the 
default tool chain may either download the required binaries or not 
require any downloads via stuart_update.

I added more info about the impact of parameters on the command just now.
>>
>> --
>> Rebecca Cran
>>
>>
>>
>>
>>
> 
> 
> 
> 
> 
> 

Re: [edk2-devel] edk2-wiki: "How to build with Stuart" - suggested changes/additions

[Rebecca Cran]

I also found a problem on Windows. It seems that BaseTools\Bin\Win32 
isn't added to %PATH% unless you run edksetup.bat - or, if you're using 
PowerShell, you can run:


$Env:PATH = 
"$pwd\BaseTools\Bin\Win32$([System.IO.Path]::PathSeparator)$Env:PATH"


-- 
Rebecca Cran


On 12/24/22 10:37, Rebecca Cran wrote:
> Mike,
>
>
> I tried following the "How to build with Stuart" document and ran into 
> a some issues on my Ubuntu 20.04 system:
>
>
> First, we now need to use "python3.9" on Ubuntu 20.04 since "python3" 
> is 3.8 which no longer works.
>
>
> Secondly, the loongarch64 gcc download is 930MB - 3.2GB once unpacked. 
> We might want to add something about specifying "-a LOONGARCH64" etc. 
> if you want to build it, or '-a X64,AARCH64' etc. if you want to skip 
> it. I ended up canceling "stuart_update" because I thought it had hung.
>
>
> Lastly, the "stuart_update" command listed doesn't work: it seems you 
> need to specify a TOOL_CHAIN_TAG to have it download anything.
>
>

Re: [edk2-devel] edk2-wiki: "How to build with Stuart" - suggested changes/additions

[Michael D Kinney]

+Michael Kubacki

> -----Original Message-----
> From: Rebecca Cran <rebecca@bsdio.com>
> Sent: Wednesday, December 28, 2022 7:47 PM
> To: Kinney, Michael D <michael.d.kinney@intel.com>; devel@edk2.groups.io
> Subject: Re: [edk2-devel] edk2-wiki: "How to build with Stuart" - suggested changes/additions
> 
> I also found a problem on Windows. It seems that BaseTools\Bin\Win32
> isn't added to %PATH% unless you run edksetup.bat - or, if you're using
> PowerShell, you can run:
> 
> 
> $Env:PATH =
> "$pwd\BaseTools\Bin\Win32$([System.IO.Path]::PathSeparator)$Env:PATH"
> 
> 
> --
> Rebecca Cran
> 
> 
> On 12/24/22 10:37, Rebecca Cran wrote:
> > Mike,
> >
> >
> > I tried following the "How to build with Stuart" document and ran into
> > a some issues on my Ubuntu 20.04 system:
> >
> >
> > First, we now need to use "python3.9" on Ubuntu 20.04 since "python3"
> > is 3.8 which no longer works.
> >
> >
> > Secondly, the loongarch64 gcc download is 930MB - 3.2GB once unpacked.
> > We might want to add something about specifying "-a LOONGARCH64" etc.
> > if you want to build it, or '-a X64,AARCH64' etc. if you want to skip
> > it. I ended up canceling "stuart_update" because I thought it had hung.
> >
> >
> > Lastly, the "stuart_update" command listed doesn't work: it seems you
> > need to specify a TOOL_CHAIN_TAG to have it download anything.
> >
> >

Re: [edk2-devel] edk2-wiki: "How to build with Stuart" - suggested changes/additions

[Sean]

[-- Attachment #1: Type: text/plain, Size: 2380 bytes --]

Rebecca,

I don't see detailed instructions for how to build the base tools in the new wiki pages. But if you use the python /pytool method then a path file is generated and Stuart will set the path correctly.

This file should be used to build the base tools
https://github.com/tianocore/edk2/blob/master/BaseTools/Edk2ToolsBuild.py

You can read a little more about the feature here. https://www.tianocore.org/edk2-pytool-extensions/features/sde/#path_env-descriptors

Thanks
Sean


________________________________
From: devel@edk2.groups.io <devel@edk2.groups.io> on behalf of Michael D Kinney <michael.d.kinney@intel.com>
Sent: Thursday, December 29, 2022 9:22 AM
To: devel@edk2.groups.io <devel@edk2.groups.io>; rebecca@bsdio.com <rebecca@bsdio.com>; Kubacki, Michael <michael.kubacki@microsoft.com>
Cc: Kinney, Michael D <michael.d.kinney@intel.com>
Subject: Re: [edk2-devel] edk2-wiki: "How to build with Stuart" - suggested changes/additions

+Michael Kubacki

> -----Original Message-----
> From: Rebecca Cran <rebecca@bsdio.com>
> Sent: Wednesday, December 28, 2022 7:47 PM
> To: Kinney, Michael D <michael.d.kinney@intel.com>; devel@edk2.groups.io
> Subject: Re: [edk2-devel] edk2-wiki: "How to build with Stuart" - suggested changes/additions
>
> I also found a problem on Windows. It seems that BaseTools\Bin\Win32
> isn't added to %PATH% unless you run edksetup.bat - or, if you're using
> PowerShell, you can run:
>
>
> $Env:PATH =
> "$pwd\BaseTools\Bin\Win32$([System.IO.Path]::PathSeparator)$Env:PATH"
>
>
> --
> Rebecca Cran
>
>
> On 12/24/22 10:37, Rebecca Cran wrote:
> > Mike,
> >
> >
> > I tried following the "How to build with Stuart" document and ran into
> > a some issues on my Ubuntu 20.04 system:
> >
> >
> > First, we now need to use "python3.9" on Ubuntu 20.04 since "python3"
> > is 3.8 which no longer works.
> >
> >
> > Secondly, the loongarch64 gcc download is 930MB - 3.2GB once unpacked.
> > We might want to add something about specifying "-a LOONGARCH64" etc.
> > if you want to build it, or '-a X64,AARCH64' etc. if you want to skip
> > it. I ended up canceling "stuart_update" because I thought it had hung.
> >
> >
> > Lastly, the "stuart_update" command listed doesn't work: it seems you
> > need to specify a TOOL_CHAIN_TAG to have it download anything.
> >
> >






[-- Attachment #2: Type: text/html, Size: 4352 bytes --]

Re: [edk2-devel] edk2-wiki: "How to build with Stuart" - suggested changes/additions

[Rebecca Cran]

[-- Attachment #1: Type: text/plain, Size: 2670 bytes --]

Thanks! That was the step I was missing - I was still running edksetup.bat instead of Edk2ToolsBuild.py.

--

Rebecca Cran

On 12/30/22 00:07, Sean Brogan wrote:
> Rebecca,
>
> I don't see detailed instructions for how to build the base tools in 
> the new wiki pages. But if you use the python /pytool method then a 
> path file is generated and Stuart will set the path correctly.
>
> This file should be used to build the base tools
> https://github.com/tianocore/edk2/blob/master/BaseTools/Edk2ToolsBuild.py
>
> You can read a little more about the feature here. 
> https://www.tianocore.org/edk2-pytool-extensions/features/sde/#path_env-descriptors
>
> Thanks
> Sean
>
>
> ------------------------------------------------------------------------
> *From:* devel@edk2.groups.io <devel@edk2.groups.io> on behalf of 
> Michael D Kinney <michael.d.kinney@intel.com>
> *Sent:* Thursday, December 29, 2022 9:22 AM
> *To:* devel@edk2.groups.io <devel@edk2.groups.io>; rebecca@bsdio.com 
> <rebecca@bsdio.com>; Kubacki, Michael <michael.kubacki@microsoft.com>
> *Cc:* Kinney, Michael D <michael.d.kinney@intel.com>
> *Subject:* Re: [edk2-devel] edk2-wiki: "How to build with Stuart" - 
> suggested changes/additions
> +Michael Kubacki
>
> > -----Original Message-----
> > From: Rebecca Cran <rebecca@bsdio.com>
> > Sent: Wednesday, December 28, 2022 7:47 PM
> > To: Kinney, Michael D <michael.d.kinney@intel.com>; devel@edk2.groups.io
> > Subject: Re: [edk2-devel] edk2-wiki: "How to build with Stuart" - 
> suggested changes/additions
> >
> > I also found a problem on Windows. It seems that BaseTools\Bin\Win32
> > isn't added to %PATH% unless you run edksetup.bat - or, if you're using
> > PowerShell, you can run:
> >
> >
> > $Env:PATH =
> > "$pwd\BaseTools\Bin\Win32$([System.IO.Path]::PathSeparator)$Env:PATH"
> >
> >
> > --
> > Rebecca Cran
> >
> >
> > On 12/24/22 10:37, Rebecca Cran wrote:
> > > Mike,
> > >
> > >
> > > I tried following the "How to build with Stuart" document and ran into
> > > a some issues on my Ubuntu 20.04 system:
> > >
> > >
> > > First, we now need to use "python3.9" on Ubuntu 20.04 since "python3"
> > > is 3.8 which no longer works.
> > >
> > >
> > > Secondly, the loongarch64 gcc download is 930MB - 3.2GB once unpacked.
> > > We might want to add something about specifying "-a LOONGARCH64" etc.
> > > if you want to build it, or '-a X64,AARCH64' etc. if you want to skip
> > > it. I ended up canceling "stuart_update" because I thought it had 
> hung.
> > >
> > >
> > > Lastly, the "stuart_update" command listed doesn't work: it seems you
> > > need to specify a TOOL_CHAIN_TAG to have it download anything.
> > >
> > >
>
>
> 
>
>

[-- Attachment #2: Type: text/html, Size: 7542 bytes --]

Re: [edk2-devel] edk2-wiki: "How to build with Stuart" - suggested changes/additions

[Michael Kubacki]

The instructions to build base tools with Edk2ToolsBuild.py are in 
"Example: I want to build BaseTools." on the page.

On 12/30/2022 2:24 AM, Rebecca Cran wrote:
> Thanks! That was the step I was missing - I was still running edksetup.bat instead of Edk2ToolsBuild.py.
> 
> --
> 
> Rebecca Cran
> 
> On 12/30/22 00:07, Sean Brogan wrote:
>> Rebecca,
>>
>> I don't see detailed instructions for how to build the base tools in 
>> the new wiki pages. But if you use the python /pytool method then a 
>> path file is generated and Stuart will set the path correctly.
>>
>> This file should be used to build the base tools
>> https://github.com/tianocore/edk2/blob/master/BaseTools/Edk2ToolsBuild.py
>>
>> You can read a little more about the feature here. 
>> https://www.tianocore.org/edk2-pytool-extensions/features/sde/#path_env-descriptors
>>
>> Thanks
>> Sean
>>
>>
>> ------------------------------------------------------------------------
>> *From:* devel@edk2.groups.io <devel@edk2.groups.io> on behalf of 
>> Michael D Kinney <michael.d.kinney@intel.com>
>> *Sent:* Thursday, December 29, 2022 9:22 AM
>> *To:* devel@edk2.groups.io <devel@edk2.groups.io>; rebecca@bsdio.com 
>> <rebecca@bsdio.com>; Kubacki, Michael <michael.kubacki@microsoft.com>
>> *Cc:* Kinney, Michael D <michael.d.kinney@intel.com>
>> *Subject:* Re: [edk2-devel] edk2-wiki: "How to build with Stuart" - 
>> suggested changes/additions
>> +Michael Kubacki
>>
>> > -----Original Message-----
>> > From: Rebecca Cran <rebecca@bsdio.com>
>> > Sent: Wednesday, December 28, 2022 7:47 PM
>> > To: Kinney, Michael D <michael.d.kinney@intel.com>; devel@edk2.groups.io
>> > Subject: Re: [edk2-devel] edk2-wiki: "How to build with Stuart" - 
>> suggested changes/additions
>> >
>> > I also found a problem on Windows. It seems that BaseTools\Bin\Win32
>> > isn't added to %PATH% unless you run edksetup.bat - or, if you're using
>> > PowerShell, you can run:
>> >
>> >
>> > $Env:PATH =
>> > "$pwd\BaseTools\Bin\Win32$([System.IO.Path]::PathSeparator)$Env:PATH"
>> >
>> >
>> > --
>> > Rebecca Cran
>> >
>> >
>> > On 12/24/22 10:37, Rebecca Cran wrote:
>> > > Mike,
>> > >
>> > >
>> > > I tried following the "How to build with Stuart" document and ran into
>> > > a some issues on my Ubuntu 20.04 system:
>> > >
>> > >
>> > > First, we now need to use "python3.9" on Ubuntu 20.04 since "python3"
>> > > is 3.8 which no longer works.
>> > >
>> > >
>> > > Secondly, the loongarch64 gcc download is 930MB - 3.2GB once unpacked.
>> > > We might want to add something about specifying "-a LOONGARCH64" etc.
>> > > if you want to build it, or '-a X64,AARCH64' etc. if you want to skip
>> > > it. I ended up canceling "stuart_update" because I thought it had 
>> hung.
>> > >
>> > >
>> > > Lastly, the "stuart_update" command listed doesn't work: it seems you
>> > > need to specify a TOOL_CHAIN_TAG to have it download anything.
>> > >
>> > >
>>
>>
>>
>>
>>
>