X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=ReleaseNotes.txt;h=372703ef820c2df056ffea6a1314572abbbaaebf;hp=045e4102a7083914624ab3bc4e1a063aa2ecad14;hb=67513de53722cf54a414dd80cc68e7d48f73be78;hpb=54c9f9ed9591fcff7a201447a2c41a58c35f8fef

diff --git a/ReleaseNotes.txt b/ReleaseNotes.txt
index 045e4102a7..372703ef82 100644
--- a/ReleaseNotes.txt
+++ b/ReleaseNotes.txt
@@ -65,10 +65,12 @@ Java Development Kit ( Java 5.0 or later)
 Java Tools
     Apache-ANT, version 1.6.5 or later (http://ant.apache.org)
     Ant-contrib, version 1.0b2 or later
-      (http://sourceforge.net/project/showfiles.php?group_id=36177)
+      (http://prdownloads.sourceforge.net/ant-contrib/ant-contrib-1.0b2-bin.zip?download)
     Saxon8, version 8.1.1
       (http://prdownloads.sourceforge.net/saxon/saxonb8-1-1.zip?download)
-    XMLBeans, version 2.1.0 or later (http://xmlbeans.apache.org) 
+    XMLBeans, version 2.1.0 (http://xmlbeans.apache.org)
+      DO NOT download the latest XMLBeans, version 2.2.0. It cannot work with
+      Saxon8, version 8.1.1.
 
 Other Tools
     TortoiseSVN version 1.3.3. (http://tortoisesvn.tigris.org/)
@@ -111,7 +113,7 @@ The URL of the document repository is:
 
 
 -----------------------
-Notes On Required Tools (MS Windows environment example)
+Notes On Required Tools (With examples for Windows, OS X, and Linux) 
 -----------------------
 Software Installation Order:
   After installing the compiler tools and your Subversion client, the following
@@ -121,10 +123,12 @@ Software Installation Order:
 Java Development Kit:
  
    The Java Environment Variable must be set before attempting to build.
-       i.e. For Sun JDK (see note below*):
-              set JAVA_HOME=c:\ Java\jdk1.5.0_06  
-       i.e. For Bea Systems:
-              set JAVA_HOME=c:\Program Files\Java\jrockit-R26.0.0-jdk1.5.0_04
+       For Sun JDK (see note below*):
+              set JAVA_HOME=c:\Java\jdk1.5.0_06  (Windows example)
+              export JAVA_HOME=/Library/Java/Home/ (OS X example)
+              export JAVA_HOME=/usr/lib/j2sdk1.5-sun/ (Linux example)
+       For Bea Systems:
+              set JAVA_HOME=c:\Java\jrockit-R26.0.0-jdk1.5.0_04
  
   *When using the Sun JDK5.0
     During installation, you should specify the install directory as C:\Java
@@ -143,13 +147,15 @@ Java Tools:
     The Apache-ANT requires the ANT_HOME environment variable to be set before
     attempting to build:
          i.e.  set ANT_HOME=c:\<full path to where ant was installed>
+          export ANT_HOME=~/ExternalTools/apache-ant (OS X and Linux example)
 
     The ant-contrib.jar file should be installed in the %ANT_HOME%\lib 
     directory.
 
     The XMLBeans, requires the XMLBEANS_HOME environment variable to be set
     before attempting to build:
-         i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans  was installed>
+         i.e. set XMLBEANS_HOME=C:\<full path to where xmlbeans was installed>
+          export XMLBEANS_HOME=~/ExternalTools/xmlbeans (OS X and Linux example)
 
     The saxon8.jar file should be copied to the %XMLBEANS_HOME%\lib directory.
 
@@ -162,6 +168,9 @@ Java Tools:
 -------------------------------------------------------------------------------
 Quick Start
 -----------
+For editing text files under Windows, use the Wordpad application.  Notepad
+does not handle UNIX style newline characters properly.
+
 Copy the target.template file in the Tools/Conf directory to target.txt, which
 must also be in the Tools/Conf directory.
 
@@ -170,13 +179,14 @@ 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), 
 tagname(s) and architecture(s) to less than the full set of possible options. 
 
-The ACTIVE_PLATFORM MUST BE SET.  All other options need not be set, however by 
-unsetting these options (by removing the line from the file, or leaving the Value 
-empty) will result in all available build possibilites when typing build.  By
-default EDK II can build a matrix of binaries, using different target types, tool
-chain tags and architectures.  Options to target.txt file are as follows:
+The ACTIVE_PLATFORM must be set unless the current working directory contains one
+or more FPD files.  All other options need not be set, however by unsetting these
+options (by removing the line from the file, or leaving the Value empty) will 
+result in all available build possibilites when typing build.  By default EDK II
+can build a matrix of binaries, using different target types, tool chain tags and 
+architectures.  Options to target.txt file are as follows:
 
-ACTIVE_PLATFORM =  Value   REQUIRED
+ACTIVE_PLATFORM =  Value   RECOMMENDED
   Where Value is the WORKSPACE relative path and filename of a Framework Platform 
   Definition (FPD) File.  Example:
 
@@ -275,6 +285,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:
     c:\MyWork\Edk2\> edksetup
 
+On Unix systems you must source the edksetup.sh file to load the correct
+settings into your shell.
+
+    . edksetup.sh # Note the dot.
+
 (This command will be referred to as the setup command throughout the rest of
 this document.)
       NOTE: You should run the setup command at the start of every session.