From: "Agyeman, Prince" <prince.agyeman@intel.com>
To: devel@edk2.groups.io
Cc: Michael Kubacki <michael.a.kubacki@intel.com>,
Michael D Kinney <michael.d.kinney@intel.com>,
Nate DeSimone <nathaniel.l.desimone@intel.com>,
Liming Gao <liming.gao@intel.com>,
Ankit Sinha <ankit.sinha@intel.com>
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 [thread overview]
Message-ID: <642ca97b3e34312a292099401814a83f8c8a07fa.1556831443.git.prince.agyeman@intel.com> (raw)
In-Reply-To: <cover.1556831443.git.prince.agyeman@intel.com>
Cc: Michael Kubacki <michael.a.kubacki@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Nate DeSimone <nathaniel.l.desimone@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Ankit Sinha <ankit.sinha@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Agyeman <prince.agyeman@intel.com>
---
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
+ * <pre>
+ 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
+ </pre>
+
+**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
next prev parent reply other threads:[~2019-05-03 23:19 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-03 23:19 [edk2-platforms/devel-MinPlatform] [PATCH v3 0/2] Adding python build script Agyeman, Prince
2019-05-03 23:19 ` [edk2-platforms/devel-MinPlatform] [PATCH v3 1/2] Platform/Intel: Added " Agyeman, Prince
2019-05-04 0:36 ` [edk2-devel] " Nate DeSimone
2019-05-04 2:14 ` Kubacki, Michael A
2019-05-03 23:19 ` Agyeman, Prince [this message]
2019-05-04 0:36 ` [edk2-devel] [edk2-platforms/devel-MinPlatform] [PATCH v3 2/2] Updated the build instructions to include the python script build instructions Nate DeSimone
2019-05-04 2:14 ` Kubacki, Michael A
2019-05-04 0:36 ` [edk2-devel] [edk2-platforms/devel-MinPlatform] [PATCH v3 0/2] Adding python build script Nate DeSimone
2019-05-04 2:14 ` Kubacki, Michael A
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=642ca97b3e34312a292099401814a83f8c8a07fa.1556831443.git.prince.agyeman@intel.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox