From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mx.groups.io; dkim=missing; spf=fail (domain: intel.com, ip: , mailfrom: prince.agyeman@intel.com) Received: from mga06.intel.com (mga06.intel.com []) by groups.io with SMTP; Fri, 03 May 2019 16:19:20 -0700 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga104.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 03 May 2019 16:19:19 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.60,427,1549958400"; d="scan'208";a="148017021" Received: from paagyema-desk2.amr.corp.intel.com ([10.7.159.148]) by orsmga003.jf.intel.com with ESMTP; 03 May 2019 16:19:19 -0700 From: "Agyeman, Prince" To: devel@edk2.groups.io Cc: Michael Kubacki , Michael D Kinney , Nate DeSimone , Liming Gao , Ankit Sinha Subject: [edk2-platforms/devel-MinPlatform] [PATCH v3 2/2] Updated the build instructions to include the python script build instructions Date: Fri, 3 May 2019 16:19:19 -0700 Message-Id: <642ca97b3e34312a292099401814a83f8c8a07fa.1556831443.git.prince.agyeman@intel.com> X-Mailer: git-send-email 2.19.1.windows.1 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Cc: Michael Kubacki Cc: Michael D Kinney Cc: Nate DeSimone Cc: Liming Gao Cc: Ankit Sinha Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Agyeman --- ReadMe.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) 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. ### Build +**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. These are overridden by
+          |       |        |                 platform specific settings (build_config.cfg) and
+          |       |        |                 then command-line settings.
+          |       |        |
+          |       |        |------build_bios.py: Main build script. Generic pre-build, build,
+          |       |        |                     post-build, and clean functions.
+          |       |        |
+          |       |        |------ClevoOpenBoardPkg
+          |       |        |        |------N1xxWU
+          |       |        |                |---build_config.cfg: N1xxWU specific build
+          |       |        |                                      settings environment variables.
+          |       |        |
+          |       |        |------KabylakeOpenBoardPkg
+          |       |        |        |------KabylakeRvp3
+          |       |        |                  |---build_config.cfg: KabylakeRvp3 specific
+          |       |        |                  |                     build settings, environment variables.
+          |       |        |                  |---build_board.py: Optional board-specific pre-build, build
+          |       |        |                                      and clean post-build functions.
+          |       |        |------PurleyOpenBoardPkg
+          |       |        |       |------BoardMtOlympus
+          |       |        |                |---build_config.cfg: BoardMtOlympus specific
+          |       |        |                |                     build settings, environment variables.
+          |       |        |                |---build_board.py: Optional 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