]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/BuildNotes.txt
BaseTools/BinToPcd: Fix Python 2.7.x compatibility issue
[mirror_edk2.git] / BaseTools / BuildNotes.txt
index 4d9608400d782211e33aefa80eb847e6cdad1229..0d77df055ecb9bc03331b7cda5b72bdf74fc1d98 100644 (file)
@@ -6,7 +6,7 @@ Root Package 1.00
 Intel is a trademark or registered trademark of Intel Corporation or its\r
 subsidiaries in the United States and other countries.\r
 * Other names and brands may be claimed as the property of others.\r
-Copyright (c) 2007, Intel Corporation\r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.\r
 \r
 -------------------------------------------------------------------------------\r
 Quick Start\r
@@ -18,7 +18,7 @@ Windows:
 \r
 Unix-like:\r
   a) make -C <buildtools_project>/BaseTools\r
-  b) Look over https://edk2.tianocore.org/step-by-step-instructions.html\r
+  b) Look over https://github.com/tianocore/tianocore.github.io/wiki/Getting%20Started%20with%20EDK%20II\r
      for a helpful step-by-step guide for building 'Hello World' on\r
      various operating systems with edk2.\r
 \r
@@ -33,28 +33,28 @@ Tools in Python
 ---------------\r
 * Convert Python source to exe file\r
 \r
-  The tools written in Python can be converted into executable program which can \r
-  be executed without installing a Python interpreter.  (Generally it is easier\r
+  The tools written in Python can be converted into executable program which can\r
+  be executed without installing a Python interpreter. (Generally it is easier\r
   to run the scripts from their source on operating systems other than Windows.)\r
 \r
   For Windows and Linux, the conversion tool package is called cx_Freeze, its\r
   home page is:\r
 \r
-               http://sourceforge.net/projects/cx-freeze/\r
+    http://sourceforge.net/projects/cx-freeze/\r
 \r
-       If you have installed cx_Freeze at c:\cx_Freeze-3.0.3. Use following command\r
+  If you have installed cx_Freeze at c:\cx_Freeze-3.0.3. Use following command\r
   lines to convert MyBuild.py to MyBuild.exe (note this is an example, there is\r
   no MyBuild Python project in the BaseTools\Python tree.\r
 \r
     set PYTHONPATH=<BaseToolsDirPath>\Source\Python\r
-       c:\cx_Freeze-3.0.3\FreezePython.exe --include-modules=encodings.cp437,encodings.gbk,encodings.utf_16,encodings.utf_16_le,encodings.utf_8 --install-dir=.\mybuild MyBuild.py\r
+    c:\cx_Freeze-3.0.3\FreezePython.exe --include-modules=encodings.cp437,encodings.gbk,encodings.utf_16,encodings.utf_16_le,encodings.utf_8 --install-dir=.\mybuild MyBuild.py\r
 \r
-       The generated .exe (and .dll) files are put in "mybuild" subdirectory.\r
+  The generated .exe (and .dll) files are put in "mybuild" subdirectory.\r
 \r
-  The following is a real example with the BuildTools/trunk/BaseTools project \r
+  The following is a real example with the BuildTools/trunk/BaseTools project\r
   installed in: C:\Work\BaseTools\r
 \r
-  \r
+\r
   C:\Work\BaseTools\Source\Python> set PYTHONPATH=C:\Work\BaseTools\Source\Python\r
   C:\Work\BaseTools\Source\Python> c:\cx_Freeze-3.0.3\FreezePython.exe --include-modules=encodings.cp437,encodings.gbk,encodings.utf_16,encodings.utf_16_le,encodings.utf_8 --install-dir=C:\Work\BaseTools\Bin\Win32 build\build.py\r
 \r
@@ -70,15 +70,15 @@ Windows:
 \r
   The tools written in Python can be executed directly from its source directory\r
 as long as the Python interpreter (Python 2.5) has been installed. Before the execution,\r
-please make sure the environment variable PYTHONPATH is set to \r
+please make sure the environment variable PYTHONPATH is set to\r
 \r
         <buildtools_project>/BaseTools/Source/Python\r
 \r
-  There're four tools written in Python. The entrance file of each tool is listed\r
+  There're five tools written in Python. The entrance file of each tool is listed\r
 below.\r
 \r
       build               <buildtools_project>/BaseTools/Source/Python/build/build.py\r
       GenFds              <buildtools_project>/BaseTools/Source/Python/GenFds/GenFds.py\r
       Trim                <buildtools_project>/BaseTools/Source/Python/Trim/Trim.py\r
       MigrationMsa2Inf    <buildtools_project>/BaseTools/Source/Python/MigrationMsa2Inf/MigrationMsa2Inf.py\r
-\r
+      UPT                 <buildtools_project>/BaseTools/Source/Python/UPT/UPT.py\r