1. update the comments to mention the variables should be set;

2. use %CD% to replace %~dp0 to remove the last "\" in the WORKSPACE variable
3. add some comments

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

edksetup.bat

@@ -4,14 +4,16 @@
 @REM are licensed and made available under the terms and conditions of the BSD License
 @REM which accompanies this distribution.  The full text of the license may be found at
 @REM http://opensource.org/licenses/bsd-license.php
-@REM 
+@REM
 @REM THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 @REM WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 @REM
 
 @REM set following environment in this file or in command shell
 @REM set JAVA_HOME=C:\Java\jdk1.5.0_04
-@REM set WORKSPACE=C:\mdk
+@REM set ANT_HOME=C:\ANT
+@REM set XMLBEANS_HOME=C:\xmlbeans
+@REM set CYGWIN_HOME=C:\cygwin
 
 
 @REM ##############################################################
@@ -20,8 +22,12 @@
 
 @echo off
 
+@REM
+@REM Check the required system environment variables
+@REM
+
 :check_vc
-if defined VCINSTALLDIR goto check_java
+if defined VCINSTALLDIR goto check_cygwin
 if defined VS71COMNTOOLS (
   call "%VS71COMNTOOLS%vsvars32.bat"
 ) else (
@@ -30,96 +36,114 @@ if defined VS71COMNTOOLS (
   echo.
 )
 
-:check_java
-if "%JAVA_HOME%"=="" goto no_jdk
-echo.
-echo JAVA_HOME:     %JAVA_HOME%
-
-@REM Set the WORKSPACE to the Current Working Directory
-set WORKSPACE=%~dp0
-echo WORKSPACE:     %WORKSPACE%
-
-:set_cygwin
-if not defined CYGWIN_HOME (
-  if exist c:\cygwin (set CYGWIN_HOME=c:\cygwin) else (
-    echo.
-    echo !!! Not set CYGWIN_HOME, gcc build may not be used !!!
-    echo.
-  )
+:check_cygwin
+if defined CYGWIN_HOME goto check_java
+if exist c:\cygwin (
+  set CYGWIN_HOME=c:\cygwin
 ) else (
-  echo CYGWIN_HOME:   %CYGWIN_HOME%
+  echo.
+  echo !!! WARNING !!!! Not set CYGWIN_HOME, gcc build may not be used !!!
+  echo.
 )
 
+:check_java
+if "%JAVA_HOME%"=="" goto no_jdk
+
+:check_ant
 if "%ANT_HOME%"=="" goto no_ant
-echo ANT_HOME:      %ANT_HOME%
 if not exist %ANT_HOME%\lib\ant-contrib.jar goto no_antcontrib
 
+:check_xmlbeans
 if "%XMLBEANS_HOME%"=="" goto no_xmlbeans
-echo XMLBEANS_HOME: %XMLBEANS_HOME%
-
-set Framework_Tools_Path=%WORKSPACE%\Tools\bin
-
-
-set PATH=%Framework_Tools_Path%;%PATH%
-
-echo PATH:      %PATH%
-echo.
-
 if not exist %XMLBEANS_HOME%\lib\saxon8.jar goto no_saxon8
 
-echo Building the Tiano Tools
+@REM
+@REM Set the WORKSPACE to the current working directory
+@REM
+set WORKSPACE=%CD%
 
-@REM We are going to create the SurfaceArea.jar file first so that other Java Program can use it
-@REM It needs the xmlbeans libaries in order to compile.
+set FRAMEWORK_TOOLS_PATH=%WORKSPACE%\Tools\Bin
+set PATH=%FRAMEWORK_TOOLS_PATH%;%PATH%
+
+echo.
+echo JAVA_HOME:     %JAVA_HOME%
+echo ANT_HOME:      %ANT_HOME%
+echo XMLBEANS_HOME: %XMLBEANS_HOME%
+echo CYGWIN_HOME:   %CYGWIN_HOME%
+echo WORKSPACE:     %WORKSPACE%
+echo PATH:          %PATH%
+echo.
+
+@REM
+@REM Start to build the Framework Tools
+@REM
+
+echo.
+echo Building the Framework Tools
+echo.
+
+@REM
+@REM We are going to create the SurfaceArea.jar file first so that the other
+@REM Java Programs can use it.
+@REM It needs the XMLBEANS libraries in order to compile.
+@REM
 set CLASSPATH=%XMLBEANS_HOME%\lib\jsr173_1.0_api.jar;%XMLBEANS_HOME%\lib\xbean.jar
 set CLASSPATH=%CLASSPATH%;%XMLBEANS_HOME%\lib\xbean_xpath.jar;%XMLBEANS_HOME%\lib\xmlpublic.jar
 set CLASSPATH=%CLASSPATH%;%XMLBEANS_HOME%\lib\saxon8.jar;%XMLBEANS_HOME%\lib\resolver.jar
 
-call ant -f %WORKSPACE%Tools\build.xml SurfaceArea
+call ant -f %WORKSPACE%\Tools\build.xml SurfaceArea
 
+@REM
 @REM Now we can make the other Java Programs
 @REM All of the remaining Java Programs require the SurfaceArea library to compile
-set CLASSPATH=%CLASSPATH%;%WORKSPACE%Tools\Jars\SurfaceArea.jar
+@REM
+set CLASSPATH=%CLASSPATH%;%WORKSPACE\%Tools\Jars\SurfaceArea.jar
 
-call ant -f %WORKSPACE%Tools\build.xml JavaCode
+call ant -f %WORKSPACE%\Tools\build.xml JavaCode
 
-@REM We have all of the Java Programs and add-in classes created, so we can start using the cpp-tasks to create our tools
-set CLASSPATH=%CLASSPATH%;%WORKSPACE%Tools\Jars\SurfaceArea.jar;%WORKSPACE%Tools\Jars\GenBuild.jar
-set CLASSPATH=%CLASSPATH%;%WORKSPACE%Tools\Jars\cpptasks.jar;%WORKSPACE%Tools\Jars\frameworktasks.jar
+@REM
+@REM We have all of the Java Programs and add-in classes created, so we can start
+@REM using the cpp-tasks to create our tools
+@REM
+set CLASSPATH=%CLASSPATH%;%WORKSPACE%\Tools\Jars\SurfaceArea.jar;%WORKSPACE%\Tools\Jars\GenBuild.jar
+set CLASSPATH=%CLASSPATH%;%WORKSPACE%\Tools\Jars\cpptasks.jar;%WORKSPACE%\Tools\Jars\frameworktasks.jar
 
-call ant -f %WORKSPACE%Tools\build.xml C_Code
+call ant -f %WORKSPACE%\Tools\build.xml C_Code
 
+@REM
+@REM Done!!!
+@REM
 goto end
 
 :no_jdk
 echo.
 echo !!! Please install Java, and set JAVA_HOME !!!
 echo.
-goto end 
+goto end
 
 :no_ant
 echo.
 echo !!! Please install Apache Ant, and set ANT_HOME !!!
 echo.
-goto end 
+goto end
 
 :no_antcontrib
 echo.
 echo !!! Please install Ant-contrib to ANT_HOME !!!
 echo.
-goto end 
+goto end
 
 :no_xmlbeans
 echo.
 echo !!! Please install XML Beans, and set XMLBEANS_HOME !!!
 echo.
-goto end 
+goto end
 
 :no_saxon8
 echo.
 echo !!! Please copy saxon8.jar file to XMLBEANS_HOME\lib !!!
 echo.
-goto end 
+goto end
 
 :end
 @echo on