From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 134.134.136.65, mailfrom: michael.a.kubacki@intel.com) Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by groups.io with SMTP; Fri, 03 May 2019 19:14:58 -0700 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 03 May 2019 19:14:58 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.60,428,1549958400"; d="scan'208";a="343276602" Received: from orsmsx104.amr.corp.intel.com ([10.22.225.131]) by fmsmga005.fm.intel.com with ESMTP; 03 May 2019 19:14:57 -0700 Received: from orsmsx151.amr.corp.intel.com (10.22.226.38) by ORSMSX104.amr.corp.intel.com (10.22.225.131) with Microsoft SMTP Server (TLS) id 14.3.408.0; Fri, 3 May 2019 19:14:56 -0700 Received: from orsmsx122.amr.corp.intel.com ([169.254.11.68]) by ORSMSX151.amr.corp.intel.com ([169.254.7.24]) with mapi id 14.03.0415.000; Fri, 3 May 2019 19:14:56 -0700 From: "Kubacki, Michael A" To: "devel@edk2.groups.io" , "Agyeman, Prince" CC: "Kinney, Michael D" , "Desimone, Nathaniel L" , "Gao, Liming" , "Sinha, Ankit" Subject: Re: [edk2-devel] [edk2-platforms/devel-MinPlatform] [PATCH v3 2/2] Updated the build instructions to include the python script build instructions Thread-Topic: [edk2-devel] [edk2-platforms/devel-MinPlatform] [PATCH v3 2/2] Updated the build instructions to include the python script build instructions Thread-Index: AQHVAgalGMSb/rRypkCOvlfJwDWgCaZaOjYg Date: Sat, 4 May 2019 02:14:55 +0000 Message-ID: <49AB4ACB9627B8468F29D589A27B7455888E6FA0@ORSMSX122.amr.corp.intel.com> References: <642ca97b3e34312a292099401814a83f8c8a07fa.1556831443.git.prince.agyeman@intel.com> In-Reply-To: <642ca97b3e34312a292099401814a83f8c8a07fa.1556831443.git.prince.agyeman@intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiYTc2ZGFjMTMtNDcyOS00ZDIyLWFlOTktNzA3NmEwMzVhNTI1IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiaEtIdDVrZG8wRXVVN2dvNHVzWE9OejUwaVwvcGNDd3pXRGdHSERzb3B1T0tmc3dEcFdwMWltOFJmaFpLcEJBK0UifQ== x-ctpclassification: CTP_NT dlp-product: dlpe-windows dlp-version: 11.0.600.7 dlp-reaction: no-action x-originating-ip: [10.22.254.139] MIME-Version: 1.0 Return-Path: michael.a.kubacki@intel.com Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Reviewed-by: Michael Kubacki > -----Original Message----- > From: devel@edk2.groups.io [mailto:devel@edk2.groups.io] On Behalf Of > Agyeman, Prince > Sent: Friday, May 3, 2019 4:19 PM > To: devel@edk2.groups.io > Cc: Kubacki, Michael A ; Kinney, Michael D > ; Desimone, Nathaniel L > ; Gao, Liming ; > Sinha, Ankit > Subject: [edk2-devel] [edk2-platforms/devel-MinPlatform] [PATCH v3 2/2] > Updated the build instructions to include the python script build instru= ctions >=20 > Cc: Michael Kubacki > Cc: Michael D Kinney > Cc: Nate DeSimone > Cc: Liming Gao > Cc: Ankit Sinha >=20 > Contributed-under: TianoCore Contribution Agreement 1.1 > Signed-off-by: Agyeman > --- > ReadMe.md | 76 > +++++++++++++++++++++++++++++++++++++++++++++++++++++++ > 1 file changed, 76 insertions(+) >=20 > diff --git a/ReadMe.md b/ReadMe.md > index 72e332a476..fbf735173f 100644 > --- a/ReadMe.md > +++ b/ReadMe.md > @@ -105,6 +105,82 @@ return back to the minimum platform caller. >=20 > ### Build >=20 > +**Building with the python script** > + > +1. Open command window, go to the workspace directory, e.g. > c:\Kabylake. > +2. Type "cd edk2-platforms\Platform\Intel 3. Type "python build_bios.py > +-p REPLACE_WITH_BOARD_NAME" > + > +* build_bios.py arguments: > + > + | Argument | Function | > + | ----------------------|-------------------------------------| > + | -h, --help | show this help message and exit | > + | --platform, -p | the platform to build | > + | --toolchain, -t | tool Chain to use in build process | > + | --DEBUG, -d | debug flag | > + | --RELEASE, -r | release flag | > + | --TEST_RELEASE, -tr | test Release flag | > + | --RELEASE_PDB, -rp | release flag | > + | --list, -l | lists available platforms | > + | --cleanall | cleans all | > + | --clean | cleans specified platform | > + | --capsule | capsule build enabled | > + | --silent | silent build enabled | > + | --performance | performance build enabled | > + | --fsp | fsp build enabled | > + | | > + > +* For more information on build options > + * ``Type "python build_bios.py -h"`` > + > +* Note > + * ``Python 2.7.16 and Python 3.7.3 compatible`` > + * ``These python build scripts have been tested on Windows due to`` > +[cross-platform limitations](#Known-limitations) > + > +* Configuration Files > + * ``The edk2-platforms\Platform\Intel\build.cfg file contains the > +default settings used by build_bios.py`` > + * ``The default settings are under the DEFAULT_CONFIG section`` > + * ``Each board can have a settings file that will override the > +edk2-platforms\Platform\Intel\build.cfg settings`` > + * ``An example of a board specific settings:`` > + * > +``edk2- > platforms\Platform\Intel\KabylakeOpenBoardPkg\KabylakeRvp3\build > +_config.cfg`` > + > +* Workspace view of the build scripts > + * 
> +    WORKSPACE
> +          |------edk2
> +          |------edk2-non-osi
> +          |------edk2-platforms
> +          |       |---Platform
> +          |       |    |--Intel
> +          |       |        |------build.cfg: Default build settings. Th=
ese are overridden
> by
> +          |       |        |                 platform specific settings=
 (build_config.cfg) and
> +          |       |        |                 then command-line settings=
.
> +          |       |        |
> +          |       |        |------build_bios.py: Main build script. Gen=
eric pre-build,
> build,
> +          |       |        |                     post-build, and clean =
functions.
> +          |       |        |
> +          |       |        |------ClevoOpenBoardPkg
> +          |       |        |        |------N1xxWU
> +          |       |        |                |---build_config.cfg: N1xxW=
U specific build
> +          |       |        |                                      setti=
ngs environment variables.
> +          |       |        |
> +          |       |        |------KabylakeOpenBoardPkg
> +          |       |        |        |------KabylakeRvp3
> +          |       |        |                  |---build_config.cfg: Kab=
ylakeRvp3 specific
> +          |       |        |                  |                     bui=
ld settings, environment
> variables.
> +          |       |        |                  |---build_board.py: Optio=
nal board-specific pre-
> build, build
> +          |       |        |                                      and c=
lean post-build functions.
> +          |       |        |------PurleyOpenBoardPkg
> +          |       |        |       |------BoardMtOlympus
> +          |       |        |                |---build_config.cfg: Board=
MtOlympus specific
> +          |       |        |                |                     build=
 settings, environment variables.
> +          |       |        |                |---build_board.py: Optiona=
l board-specific pre-
> build,
> +          |       |        |                |                   build, =
post-build and clean functions.
> +          |------FSP
> +
> + > +**Building with the batch scripts** > For KabylakeOpenBoardPkg > 1. Open command window, go to the workspace directory, e.g. c:\Kabylake= . > 2. Type "cd edk2- > platforms\Platform\Intel\KabylakeOpenBoardPkg\KabylakeRvp3". > -- > 2.19.1.windows.1 >=20 >=20 >=20