Updated Release Notes to clean up before release.
authormichaelx_krau <michaelx_krau@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 12 Jul 2006 20:39:54 +0000 (20:39 +0000)
committermichaelx_krau <michaelx_krau@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 12 Jul 2006 20:39:54 +0000 (20:39 +0000)
- Reordered some of the sections for cleaner appearance.
- Quick Start became Detailed starting instructions
- A new Quick Start was created with the minimum of the original Quick Start information.
- general clean up and clarification of document

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@923 6f19259b-4bc3-4df7-8a09-765794883524

ReleaseNotes.txt

index fc1d46c..5d8c66e 100644 (file)
@@ -1,7 +1,7 @@
 Intel(R) Platform Innovation Framework for EFI\r
 EFI Development Kit II (EDK II) \r
 Root Package 1.00\r
-2006-07-06\r
+2006-07-12\r
 \r
 Copyright (c) 2006, Intel Corporation\r
 \r
@@ -41,6 +41,8 @@ Note: Documents have the following filenames:
       (MDE_Package_Spec_0_50.rtf)\r
   EDK II C Coding Standards Specification v0.50\r
       (C_Coding_Standards_Specification_ 0_50.rtf)\r
+  EDK II Subversion Setup Guide\r
+      (edk2-subversion-setup.rtf)\r
 \r
 Pre-Requisites\r
 --------------\r
@@ -100,17 +102,6 @@ Tianocore.org website, as part of the checkout procedures.
 The URL of the EDK II repository is:\r
   https://edk2.tianocore.org/svn/edk2/trunk/edk2\r
 \r
------------------------\r
-Notes On Documentation\r
------------------------\r
-The documents are being managed by the Subversion Source Control on\r
-Tianocore.org.  The document repository is "docs" and must be checked out\r
-separately from the EDK II source tree. Refer to the checkout procedures on\r
-the Tianocore.org website for EDK II.\r
-\r
-The URL of the document repository is:\r
-  https://edk2.tianocore.org/svn/edk2/trunk/docs\r
-\r
 \r
 -----------------------\r
 Notes On Required Tools (With examples for Windows, OS X, and Linux) \r
@@ -164,10 +155,92 @@ Java Tools:
         set PATH=%PATH%;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin\r
      Linux/OS X bash shell example:\r
         export PATH=$PATH:${ANT_HOME}/bin:${XMLBEANS_HOME}/bin\r
+\r
+--------------------\r
+A Word on Apache-ANT\r
+--------------------\r
+The Apache-ANT program is a build tool that uses XML-based project files.\r
+Similar to Makefiles, these project files may contain multiple targets.  Most\r
+build.xml files in EDK II are auto-generated; any edits performed on the\r
+build.xml files will be overwritten the next time build is executed.\r
+\r
+Pre-defined targets in the build.xml file include:\r
+    all      - This target builds binaries for defined architectures\r
+    clean    - This target removes object files generated by commands\r
+    cleanall - This target removes all generated files and directories.\r
+\r
+------------------------\r
+A Word on GCC tool chain\r
+------------------------\r
+EDK II will not compile with a standard Linux gcc tool chain. While Linux\r
+distributions are usually based on ELF, EDK II requires a version of gcc \r
+that is configured to produce PE-COFF images. You will find a script in \r
+edk2/Tools/gcc that will download, configure, compile, and install a gcc \r
+4.X cross-compile tool chain for EDK II development. It has support for \r
+the IA32 architecture. It can be built and run on Cygwin, Linux, and many \r
+other POSIX compliant host operating environments. There are a few tools\r
+that you will need on your host computer in order to compile the tool \r
+chain. Among them are bash, gcc, gmake, curl (or wget).\r
+\r
+\r
+-----------------------\r
+Notes On Documentation\r
+-----------------------\r
+The documents are being managed by the Subversion Source Control on\r
+Tianocore.org.  The document repository is "docs" and must be checked out\r
+separately from the EDK II source tree. Refer to the checkout procedures on\r
+the Tianocore.org website for EDK II.\r
+\r
+The URL of the document repository is:\r
+  https://edk2.tianocore.org/svn/edk2/trunk/docs\r
+\r
  \r
 -------------------------------------------------------------------------------\r
-Quick Start\r
+Quick Start \r
 -----------\r
+(assumes Microsoft Tools and OS Environment, for GCC Tools or Unix, please see \r
+"Detailed Starting Instructions" below)\r
+\r
+Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to\r
+checkout the entire EDK II source tree.\r
+\r
+In a command window, change to the top level directory of the Edk II sources.\r
+\r
+To test your tool chain setup and to build the Supplied Tools, execute:\r
+    c:\MyWork\edkii\> edksetup ForceBuild\r
+\r
+(The edksetup command will be referred to as the setup command throughout the \r
+rest of this document.)\r
+      NOTE: You should run the setup command at the start of every session.\r
+            This configures the environment to include the TianoTools and the\r
+            Java applications and libraries.\r
+\r
+You will need to set the WORKSPACE environment variable, or run the edksetup\r
+script (without any arguments) any time you want to build.\r
+\r
+  Set the WORKSPACE environment variable, e.g.:\r
+\r
+    c:\> set WORKSPACE=C:\MyWork\edkii\r
+\r
+You may need to edit the text files, Tools/Conf/target.txt and\r
+Tools/Conf/tools_def.txt (created by edksetup,) using your favorite \r
+text editor to ensure that the paths to the tools you want to use \r
+to build EDK II binaries are correct.  These files contain the default \r
+paths (as per the default installation of the tools), so a customized \r
+install may require this manual process.\r
+\r
+Once this is completed, you are ready to test the Build, by executing:\r
+    c:\MyWork\edkii\> build\r
+\r
+This command builds active platform specified in text file target.txt. If \r
+active platform is not specified, go to sub-directory which contains FPD files and\r
+type build. More information about active platform policy reference to specification\r
+<<EDK II Build and Packaging Architecture Specification>>.\r
+\r
+-------------------------------------------------------------------------------\r
+Detailed Start Instructions\r
+---------------------------\r
+\r
 Follow the instructions at https://edk2.tianocore.org/servlets/ProjectSource to\r
 checkout the entire EDK II source tree.\r
 \r
@@ -185,8 +258,8 @@ settings into your shell.
 \r
     . edksetup.sh # Note the dot.\r
 \r
-(This command will be referred to as the setup command throughout the rest of\r
-this document.)\r
+The edksetup command will be referred to as the setup command throughout the \r
+rest of this document.)\r
       NOTE: You should run the setup command at the start of every session.\r
             This configures the environment to include the TianoTools and the\r
             Java applications and libraries.\r
@@ -202,9 +275,12 @@ script (without any arguments) any time you want to build.
 \r
     c:\> set WORKSPACE=C:\MyWork\edkii\r
 \r
-You may need to edit the text files, Tools/Conf/target.txt and/or\r
+You may need to edit the text files, Tools/Conf/target.txt and\r
 Tools/Conf/tools_def.txt (created by edksetup,) using your favorite \r
-text editor to point to the tools you want to use to build EDK II binaries.\r
+text editor to ensure that the paths to the tools you want to use \r
+to build EDK II binaries are correct.  These files contain the default \r
+paths (as per the default installation of the tools), so a customized \r
+tool installation may require this manual process.\r
 \r
 Once this is completed, you are ready to test the Build, by executing:\r
     c:\MyWork\edkii\> build\r
@@ -245,31 +321,6 @@ After running the setup command, you can build individual modules.
 \r
   Note active platform must be set for individual module build. \r
 \r
--------------------------------------------------------------------------------\r
-A Word on Apache-ANT\r
---------------------\r
-The Apache-ANT program is a build tool that uses XML-based project files.\r
-Similar to Makefiles, these project files may contain multiple targets.  Most\r
-build.xml files in EDK II are auto-generated; any edits performed on the\r
-build.xml files will be overwritten the next time build is executed.\r
-\r
-Pre-defined targets in the build.xml file include:\r
-    all      - This target builds binaries for defined architectures\r
-    clean    - This target removes object files generated by commands\r
-    cleanall - This target removes all generated files and directories.\r
-\r
-A Word on GCC tool chain\r
-------------------------\r
-EDK II will not compile with a standard Linux gcc tool chain. While Linux\r
-distributions are usually based on ELF, EDK II requires a version of gcc \r
-that is configured to produce PE-COFF images. You will find a script in \r
-edk2/Tools/gcc that will download, configure, compile, and install a gcc \r
-4.X cross-compile tool chain for EDK II development. It has support for \r
-the IA32 architecture. It can be built and run on Cygwin, Linux, and many \r
-other POSIX compliant host operating environments. There are a few tools\r
-that you will need on your host computer in order to compile the tool \r
-chain. Among them are bash, gcc, gmake, curl (or wget).\r
-\r
 -------------------------------------------------------------------------------\r
 \r
 General Information:\r