Updated per the build tools changes
authorjwang36 <jwang36@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 19 Jul 2007 01:43:29 +0000 (01:43 +0000)
committerjwang36 <jwang36@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 19 Jul 2007 01:43:29 +0000 (01:43 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@3337 6f19259b-4bc3-4df7-8a09-765794883524

BuildNotes2.txt

index a5d2e3e..120c354 100644 (file)
@@ -28,8 +28,6 @@ Note:
 Quick Start\r
 -----------\r
 \r
-NOTE: Please confirm you have already installed Python on your machine.\r
-\r
 In a command window, change to the top-level directory of the EDK II source.\r
 \r
 First, set up your workspace. If you have had a setup, please make sure that\r
@@ -43,7 +41,7 @@ and then begin to build
     c:\MyWork\edk2\> build\r
 \r
 If you want to build the modules in other packages\r
-(For example, MdePkg\Library\BaseLib\BaseLib.inf), please edit open the BaseTools\Conf\Target.txt firstly,\r
+(For example, MdePkg\Library\BaseLib\BaseLib.inf), please edit open the <WORKSPACE>\Conf\Target.txt first,\r
 \r
 change the following line\r
     ACTIVE_PLATFORM       = MdeModulePkg/MdeModulePkg.dsc\r
@@ -57,6 +55,32 @@ and then go to MdePkg\Library\BaseLib directory and build
 If you want build a platform, ACTIVE_PLATFORM must be set to your desired platform dsc file,\r
 go to directory which must be not a module's directory, and run "build" command.\r
 \r
+Instead of changing Target.txt, you can specify platform, module and/or architecture on command line.\r
+For example, if you want to build NT32 platform, you can just type \r
+\r
+               c:\MyWork\edk2\> build -p Nt32Pkg\Nt32Pkg.dsc -a IA32\r
+\r
+and if you want to build HelloWorld module, you can just type\r
+\r
+               c:\MyWork\edk2\> build -p Nt32Pkg\Nt32Pkg.dsc -a IA32 -m MdeModulePkg\Application\HelloWorld\HelloWorld.inf\r
+\r
+Other helpful command line options of build tool include "-v" and "-d". "-v" option is used to turn on\r
+the verbose build, which provide more information during the build. "-d <debug level 0-9>" option is used to\r
+turn on the debug information which is helpful debugging build tools.\r
+\r
+For more information on build options, please try "build -h" on command line. Note that "/?" is not working.\r
+\r
+\r
+-------------------------------------------------------------------------------\r
+Supported build targets\r
+-----------------------\r
+\r
+all                            - Build whole platform or module. It can be ignored.\r
+clean     - Clean intermediate files\r
+cleanall  - Clean all generated files and directories during build, except Makefile\r
+cleanlib  - Clean all generated files and directories during library build\r
+run                            - Launch NT32 shell (only valid for NT32 platform)\r
+\r
 -------------------------------------------------------------------------------\r
 Tools in Python\r
 ---------------\r
@@ -69,14 +93,14 @@ have the Python interpreter (version 2.5) installed. The source of Python code i
 \r
        where:\r
 \r
-               MyBuild.py      - The temporary "build" tool from which the "build.exe" is coming\r
+               Bld.py      - The entry tool of build tools\r
                AutoGen.py  - Generate AutoGen.c/.h and makefile only\r
 \r
        "MyBuild.py" steps:\r
                1. Run "edksetup.bat newbuild"\r
                2. Set ACTIVE_PLATFORM in WORKSPACE\Conf\r
                3. Go to platform or module directory\r
-               4. Run "<python_interpreter.exe> <python_source_dir>\MyBuild.py" or "<python_source_dir>\MyBuild.py"\r
+               4. Run "<python_interpreter.exe> <python_source_dir>\Bld.py" or "<python_source_dir>\Bld.py"\r
                   directly.\r
 \r
        "AutoGen.py" steps:\r