Add more instructions for OS X and Linux.

[mirror_edk2.git] / ReleaseNotes.txt

diff --git a/ReleaseNotes.txt b/ReleaseNotes.txt
index d1866b379494e991e5b3256405a7137416e48738..418398f243253fd23eb7522b6627e23c7c9326f3 100644 (file)
--- a/ReleaseNotes.txt
+++ b/ReleaseNotes.txt
@@ -65,10 +65,12 @@ Java Development Kit ( Java 5.0 or later)
 Java Tools\r
     Apache-ANT, version 1.6.5 or later (http://ant.apache.org)\r
     Ant-contrib, version 1.0b2 or later\r
-      (http://sourceforge.net/project/showfiles.php?group_id=36177)\r
+      (http://prdownloads.sourceforge.net/ant-contrib/ant-contrib-1.0b2-bin.zip?download)\r
     Saxon8, version 8.1.1\r
       (http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download)\r
-    XMLBeans, version 2.1.0 or later (http://xmlbeans.apache.org) \r
+    XMLBeans, version 2.1.0 (http://xmlbeans.apache.org)\r
+      DO NOT download the latest XMLBeans, version 2.2.0. It cannot work with\r
+      Saxon8, version 8.1.1.\r
 \r
 Other Tools\r
     TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)\r
@@ -111,7 +113,7 @@ The URL of the document repository is:
 \r
 \r
 -----------------------\r
-Notes On Required Tools (MS Windows environment example)\r
+Notes On Required Tools (With examples for Windows, OS X, and Linux) \r
 -----------------------\r
 Software Installation Order:\r
   After installing the compiler tools and your Subversion client, the following\r
@@ -121,10 +123,12 @@ Software Installation Order:
 Java Development Kit:\r
  \r
    The Java Environment Variable must be set before attempting to build.\r
-       i.e. For Sun JDK (see note below*):\r
-              set JAVA_HOME=c:\ Java\jdk1.5.0_06  \r
-       i.e. For Bea Systems:\r
-              set JAVA_HOME=c:\Program Files\Java\jrockit-R26.0.0-jdk1.5.0_04\r
+       For Sun JDK (see note below*):\r
+              set JAVA_HOME=c:\Java\jdk1.5.0_06  (Windows example)\r
+              export JAVA_HOME=/Library/Java/Home/ (OS X example)\r
+              export JAVA_HOME=/usr/lib/j2sdk1.5-sun/ (Linux example)\r
+       For Bea Systems:\r
+              set JAVA_HOME=c:\Java\jrockit-R26.0.0-jdk1.5.0_04\r
  \r
   *When using the Sun JDK5.0\r
     During installation, you should specify the install directory as C:\Java\r
@@ -143,13 +147,15 @@ Java Tools:
     The Apache-ANT requires the ANT_HOME environment variable to be set before\r
     attempting to build:\r
          i.e.  set ANT_HOME=c:\<full path to where ant was installed>\r
+          export ANT_HOME=~/ExternalTools/apache-ant (OS X and Linux example)\r
 \r
     The ant-contrib.jar file should be installed in the %ANT_HOME%\lib \r
     directory.\r
 \r
     The XMLBeans, requires the XMLBEANS_HOME environment variable to be set\r
     before attempting to build:\r
-         i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans  was installed>\r
+         i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>\r
+          export XMLBEANS_HOME=~/ExternalTools/xmlbeans (OS X and Linux example)\r
 \r
     The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.\r
 \r
@@ -170,11 +176,12 @@ file contains options for setting the active platform and restricting the build.
 The restictions are used to limit the build output by specifying build target(s), \r
 tagname(s) and architecture(s) to less than the full set of possible options. \r
 \r
-The ACTIVE_PLATFORM MUST BE SET.  All other options need not be set, however by \r
-unsetting these options (by removing the line from the file, or leaving the Value \r
-empty) will result in all available build possibilites when typing build.  By\r
-default EDK II can build a matrix of binaries, using different target types, tool\r
-chain tags and architectures.  Options to target.txt file are as follows:\r
+The ACTIVE_PLATFORM must be set unless the current working directory contains one\r
+or more FPD files.  All other options need not be set, however by unsetting these\r
+options (by removing the line from the file, or leaving the Value empty) will \r
+result in all available build possibilites when typing build.  By default EDK II\r
+can build a matrix of binaries, using different target types, tool chain tags and \r
+architectures.  Options to target.txt file are as follows:\r
 \r
 ACTIVE_PLATFORM =  Value   REQUIRED\r
   Where Value is the WORKSPACE relative path and filename of a Framework Platform \r
@@ -275,6 +282,11 @@ In a command window, change to the top level directory of the Edk II sources.
 To test your tool chain setup and to build the Supplied Tools, execute:\r
     c:\MyWork\Edk2\> edksetup\r
 \r
+On Unix systems you must source the edksetup.sh file to load the correct\r
+settings into your shell.\r
+\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
       NOTE: You should run the setup command at the start of every session.\r
@@ -488,20 +500,23 @@ Example Ppi Entries (NOTE: The Guid entry is a single line in the SPD file):
     element as described above.\r
 \r
 --------------------------------------- \r
-7) Define a new PCD entry in a package:\r
+7) Declare a new PCD entry in a package:\r
   - This release requires manual editing of the SPD file to include the new\r
     PCD.  New Pcd entries are added to the PcdDefinitions section of the\r
     <PackageName>.spd file using the following example for the format:\r
     NOTE: The hex <Token> value must be unique.\r
 \r
-<PcdDefinitions>\r
+<PcdDeclarations>\r
   <PcdEntry ItemType="FIXED_AT_BUILD">\r
     <C_Name>PcdMaximumUnicodeStringLength</C_Name>\r
     <Token>0x00000001</Token>\r
+    <TokenSpaceGuidCName>gEfiMdePkgTokenSpaceGuid</TokenSpaceGuidCName>\r
     <DatumType>UINT32</DatumType>\r
+    <ValidUsage>FIXED_AT_BUILD</ValidUsage>\r
     <DefaultValue>1000000</DefaultValue>\r
+    <HelpText>The maximum lengh for unicode string.</HelpText>\r
   </PcdEntry>\r
-</PcdDefinition>\r
+</PcdDeclarations>\r
   \r
 ------------------------------\r
 8) Declare a new Library Class:\r