refine the comments

[mirror_edk2.git] / edksetup.bat

@REM @file\r
@REM   Windows batch file to setup a WORKSPACE environment\r
@REM\r
@REM Copyright (c) 2006 - 2008, Intel Corporation\r
@REM All rights reserved. This program and the accompanying materials\r
@REM are licensed and made available under the terms and conditions of the BSD License\r
@REM which accompanies this distribution.  The full text of the license may be found at\r
@REM http://opensource.org/licenses/bsd-license.php\r
@REM\r
@REM THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
@REM WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
@REM\r
\r
@REM set following environment in this file or in command shell for the older,\r
@REM      JAVA/Ant build\r
@REM set JAVA_HOME=C:\Java\jdk1.5.0_06\r
@REM set ANT_HOME=C:\ANT\r
@REM set XMLBEANS_HOME=C:\xmlbeans\r
@REM set CYGWIN_HOME=C:\cygwin\r
\r
@REM usage: \r
@REM   edksetup.bat [--nt32] [AntBuild] [Rebuild] [ForceRebuild] [Reconfig]\r
@REM if the argument, skip is present, only the paths and the\r
@REM test and set of environment settings are performed. \r
\r
@REM ##############################################################\r
@REM # You should not have to modify anything below this line\r
@REM #\r
\r
@echo off\r
\r
@REM\r
@REM Set the WORKSPACE to the current working directory\r
@REM\r
pushd .\r
cd %~dp0\r
set WORKSPACE=%CD%\r
\r
@if /I "%1"=="-h" goto Usage\r
@if /I "%1"=="-help" goto Usage\r
@if /I "%1"=="--help" goto Usage\r
@if /I "%1"=="/h" goto Usage\r
@if /I "%1"=="/?" goto Usage\r
@if /I "%1"=="/help" goto Usage\r
\r
@if /I not "%1"=="--nt32" goto check_Ant_build\r
\r
@REM Flag, --nt32 is set\r
@REM The Nt32 Emluation Platform requires Microsoft Libraries\r
@REM and headers to interface with Windows.\r
\r
if not defined VCINSTALLDIR (\r
  if defined VS71COMNTOOLS (\r
    call "%VS71COMNTOOLS%\vsvars32.bat"\r
  ) else (\r
    if defined VS80COMNTOOLS (\r
      call "%VS80COMNTOOLS%\vsvars32.bat"\r
    ) else (\r
      echo.\r
      echo !!! WARNING !!! Cannot find Visual Studio !!!\r
      echo.\r
    )\r
  )\r
)\r
shift\r
\r
:check_Ant_build\r
  @if /I "%1"=="AntBuild" goto AntBuild\r
\r
@REM\r
@REM Default is new, Makefile Base Build\r
@REM\r
\r
@if /I "%1"=="NewBuild" shift\r
@if not defined EDK_TOOLS_PATH set EDK_TOOLS_PATH=%WORKSPACE%\BaseTools\r
@IF NOT EXIST "%EDK_TOOLS_PATH%\toolsetup.bat" goto BadBaseTools\r
@call %EDK_TOOLS_PATH%\toolsetup.bat %*\r
@goto end\r
\r
:BadBaseTools\r
  @REM\r
  @REM Need the BaseTools Package in order to build\r
  @REM\r
  echo.\r
  echo !!! ERROR !!! The BaseTools Package was not found !!!\r
  echo.\r
  echo Set the system environment variable, EDK_TOOLS_PATH to the BaseTools,\r
  echo For example,\r
  echo   set EDK_TOOLS_PATH=C:\MyTools\BaseTools\r
  echo The setup script, toolsetup.bat must reside in this folder.\r
  echo.\r
  @goto end\r
\r
@REM With the exception of the :end and :Usage tags, all information below\r
@REM these lines is for the JAVA/Ant Build!\r
\r
:AntBuild\r
  @REM\r
  @REM Check the required system environment variables\r
  @REM\r
  @if /I "%1"=="AntBuild" shift\r
\r
  set FOUND="FALSE"\r
  if exist "Tools\Jars" set FOUND="TRUE"\r
  if exist "%EDK_TOOLS_PATH%\Tools\Jars" set FOUND="TRUE"\r
  if %FOUND%=="FALSE" (\r
    echo.\r
    echo !!! ERROR !!! You have selected the Java/Ant build, however those tools\r
    echo               cannot be found in this WORKSPACE.\r
    echo.\r
    echo               Please double check that the AntTools project is installed\r
    echo               in this WORKSPACE.\r
    echo.\r
    set FOUND=""\r
    goto end\r
  )\r
  set FOUND=""\r
\r
:check_vc\r
  if defined VCINSTALLDIR goto check_cygwin\r
  if defined VS71COMNTOOLS (\r
   call "%VS71COMNTOOLS%\vsvars32.bat"\r
  ) else (\r
    echo.\r
    echo !!! WARNING !!! Cannot find Visual Studio !!!\r
    echo.\r
  )\r
\r
:check_cygwin\r
  if defined CYGWIN_HOME goto check_java\r
  if exist c:\cygwin (\r
    set CYGWIN_HOME=c:\cygwin\r
  ) else (\r
    echo.\r
    echo !!! WARNING !!! No CYGWIN_HOME set, gcc build may not be used !!!\r
    echo.\r
  )\r
\r
:check_java\r
  if "%JAVA_HOME%"=="" goto no_jdk\r
\r
:check_ant\r
  if "%ANT_HOME%"=="" goto no_ant\r
  if not exist %ANT_HOME%\lib\ant-contrib.jar goto no_antcontrib\r
\r
:check_xmlbeans\r
  if "%XMLBEANS_HOME%"=="" goto no_xmlbeans\r
  if not exist %XMLBEANS_HOME%\lib\saxon8.jar goto no_saxon8\r
\r
set FRAMEWORK_TOOLS_PATH=%WORKSPACE%\Tools\bin\r
\r
if not defined ORIGINAL_CLASSPATH set ORIGINAL_CLASSPATH=%CLASSPATH%\r
set CLASSPATH=%ORIGINAL_CLASSPATH%\r
\r
if defined WORKSPACE_TOOLS_PATH goto check_path\r
set PATH=%FRAMEWORK_TOOLS_PATH%;%JAVA_HOME%\bin;%ANT_HOME%\bin;%XMLBEANS_HOME%\bin;%PATH%\r
set WORKSPACE_TOOLS_PATH=%FRAMEWORK_TOOLS_PATH%\r
echo Setting the PATH variable to include the FRAMEWORK_TOOLS_PATH for this WORKSPACE\r
goto path_ok\r
\r
:check_path\r
  if "%FRAMEWORK_TOOLS_PATH%"=="%WORKSPACE_TOOLS_PATH%" goto path_ok\r
  set PATH=%FRAMEWORK_TOOLS_PATH%;%PATH%\r
  set WORKSPACE_TOOLS_PATH=%WORKSPACE%\Tools\bin\r
  echo Resetting the PATH variable to include the FRAMEWORK_TOOLS_PATH for this WORKSPACE\r
\r
:path_ok\r
\r
  @if /I "%1"=="ForceRebuild" goto ForceBuild\r
  @if /I "%1"=="Reconfig" goto Reconfig\r
\r
@IF NOT EXIST "Tools\Jars\Common.jar" goto NormalBuild\r
@IF NOT EXIST "Tools\Jars\PcdTools.jar" goto NormalBuild\r
@IF NOT EXIST "Tools\Jars\GenBuild.jar" goto NormalBuild\r
@IF NOT EXIST "Tools\Jars\SurfaceArea.jar" goto NormalBuild\r
@IF NOT EXIST "Tools\Jars\cpptasks.jar" goto NormalBuild\r
@IF NOT EXIST "Tools\Jars\frameworktasks.jar" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\FrameworkWizard.jar" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\CompressDll.dll" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\CompressDll.lib" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\CreateMtFile.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\EfiCompress.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\EfiRom.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\FlashMap.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\FwImage.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\GenAcpiTable.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\GenCRC32Section.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\GenCapsuleHdr.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\GenDepex.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\GenFfsFile.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\GenFvImage.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\GenSection.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\GenTEImage.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\GuidChk.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\MakeDeps.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\ModifyInf.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\PeiRebase_Ia32.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\PeiRebase_Ipf.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\PeiRebase_X64.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\SecApResetVectorFixup.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\SecFixup.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\SetStamp.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\SplitFile.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\StrGather.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\Strip.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\VfrCompile.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\ZeroDebugData.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\antlr.exe" goto NormalBuild\r
@IF NOT EXIST "Tools\bin\dlg.exe" goto NormalBuild\r
\r
@if /I "%1"=="Rebuild" goto NormalBuild\r
@if NOT "%1"=="" goto Usage\r
\r
goto skipbuild\r
\r
:ForceBuild \r
  call ant -f %WORKSPACE%\Tools\build.xml -noclasspath cleanall\r
\r
:NormalBuild\r
  @REM\r
  @REM Start to build the Framework Tools\r
  @REM\r
\r
  echo.\r
  echo Building the Framework Tools\r
  echo.\r
\r
  @REM\r
  @REM We are going to create the SurfaceArea.jar file first so that the other\r
  @REM Java Programs can use it.\r
  @REM It needs the XMLBEANS libraries in order to compile.\r
  @REM\r
  set CLASSPATH=%XMLBEANS_HOME%\lib;%CLASSPATH%\r
  set CLASSPATH=%XMLBEANS_HOME%\lib\jsr173_1.0_api.jar;%CLASSPATH%\r
  set CLASSPATH=%XMLBEANS_HOME%\lib\xbean.jar;%CLASSPATH%\r
  set CLASSPATH=%XMLBEANS_HOME%\lib\xbean_xpath.jar;%CLASSPATH%\r
  set CLASSPATH=%XMLBEANS_HOME%\lib\xmlpublic.jar;%CLASSPATH%\r
  set CLASSPATH=%XMLBEANS_HOME%\lib\saxon8.jar;%CLASSPATH%\r
  set CLASSPATH=%XMLBEANS_HOME%\lib\resolver.jar;%CLASSPATH%\r
\r
  call ant -f %WORKSPACE%\Tools\build.xml SurfaceArea\r
\r
  @REM\r
  @REM Now we can make the other Java Programs\r
  @REM All of the remaining Java Programs require the SurfaceArea library to compile\r
  @REM\r
  set CLASSPATH=%WORKSPACE%\Tools\Jars\SurfaceArea.jar;%CLASSPATH%\r
\r
  call ant -f %WORKSPACE%\Tools\build.xml JavaCode\r
\r
  @REM\r
  @REM We have all of the Java Programs and add-in classes created, so we can start\r
  @REM using the cpp-tasks to create our tools\r
  @REM\r
  set CLASSPATH=%WORKSPACE%\Tools\Jars\Common.jar;%CLASSPATH%\r
  set CLASSPATH=%WORKSPACE%\Tools\Jars\PcdTools.jar;%CLASSPATH%\r
  set CLASSPATH=%WORKSPACE%\Tools\Jars\GenBuild.jar;%CLASSPATH%\r
  set CLASSPATH=%WORKSPACE%\Tools\Jars\cpptasks.jar;%CLASSPATH%\r
  set CLASSPATH=%WORKSPACE%\Tools\Jars\frameworktasks.jar;%CLASSPATH%\r
  set CLASSPATH=%WORKSPACE%\Tools\Bin\FrameworkWizard.jar;%CLASSPATH%\r
  set CLASSPATH=%WORKSPACE%\Tools\Bin\MigrationTools.jar;%CLASSPATH%\r
\r
  call ant -f %WORKSPACE%\Tools\build.xml C_Code\r
\r
  @REM\r
  @REM Done!!!\r
  @REM\r
  goto end\r
\r
:no_jdk\r
  echo.\r
  echo !!! Please install Java, and set JAVA_HOME !!!\r
  echo.\r
  goto end\r
\r
:no_ant\r
  echo.\r
  echo !!! Please install Apache Ant, and set ANT_HOME !!!\r
  echo.\r
  goto end\r
\r
:no_antcontrib\r
  echo.\r
  echo !!! Please install Ant-contrib to ANT_HOME !!!\r
  echo.\r
  goto end\r
\r
:no_xmlbeans\r
  echo.\r
  echo !!! Please install XML Beans, and set XMLBEANS_HOME !!!\r
  echo.\r
  goto end\r
\r
:no_saxon8\r
  echo.\r
  echo !!! Please copy saxon8.jar file to XMLBEANS_HOME\lib !!!\r
  echo.\r
  goto end\r
\r
:skipbuild\r
  @REM\r
  @REM This just sets up the CLASSPATH, the rest of the environment should have been set already.\r
  @REM\r
  echo.\r
  echo WORKSPACE:     %WORKSPACE%\r
  echo JAVA_HOME:     %JAVA_HOME%\r
  echo ANT_HOME:      %ANT_HOME%\r
  echo XMLBEANS_HOME: %XMLBEANS_HOME%\r
  echo CYGWIN_HOME:   %CYGWIN_HOME%\r
  echo PATH:          %PATH%\r
  echo.\r
  set CLASSPATH=%XMLBEANS_HOME%\lib;%CLASSPATH%\r
  set CLASSPATH=%XMLBEANS_HOME%\lib\jsr173_1.0_api.jar;%CLASSPATH%\r
  set CLASSPATH=%XMLBEANS_HOME%\lib\xbean.jar;%CLASSPATH%\r
  set CLASSPATH=%XMLBEANS_HOME%\lib\xbean_xpath.jar;%CLASSPATH%\r
  set CLASSPATH=%XMLBEANS_HOME%\lib\xmlpublic.jar;%CLASSPATH%\r
  set CLASSPATH=%XMLBEANS_HOME%\lib\saxon8.jar;%CLASSPATH%\r
  set CLASSPATH=%XMLBEANS_HOME%\lib\saxon8-dom.jar;%CLASSPATH%\r
  set CLASSPATH=%XMLBEANS_HOME%\lib\saxon8-xpath.jar;%CLASSPATH%\r
  set CLASSPATH=%XMLBEANS_HOME%\lib\resolver.jar;%CLASSPATH%\r
  set CLASSPATH=%WORKSPACE%\Tools\Jars\SurfaceArea.jar;%CLASSPATH%\r
  set CLASSPATH=%WORKSPACE%\Tools\Jars\Common.jar;%CLASSPATH%\r
  set CLASSPATH=%WORKSPACE%\Tools\Jars\PcdTools.jar;%CLASSPATH%\r
  set CLASSPATH=%WORKSPACE%\Tools\Jars\GenBuild.jar;%CLASSPATH%\r
  set CLASSPATH=%WORKSPACE%\Tools\Jars\cpptasks.jar;%CLASSPATH%\r
  set CLASSPATH=%WORKSPACE%\Tools\Jars\frameworktasks.jar;%CLASSPATH%\r
  set CLASSPATH=%WORKSPACE%\Tools\Bin\FrameworkWizard.jar;%CLASSPATH%\r
  set CLASSPATH=%WORKSPACE%\Tools\Bin\MigrationTools.jar;%CLASSPATH%\r
  echo CLASSPATH:     %CLASSPATH%\r
  goto end\r
\r
:Reconfig\r
  @REM\r
  @REM Reinstall all config files\r
  @REM\r
  call ant -f %WORKSPACE%\Tools\build.xml reconfig\r
  goto end\r
\r
:Usage\r
  echo.\r
  echo  Usage: "%0 [-h | -help | --help | /h | /help | /?] [--nt32] [AntBuild | Rebuild | ForceRebuild ] [Reconfig]"\r
  echo         --nt32         Call vsvars32.bat for NT32 platform build.\r
  echo.\r
  echo         Rebuild        If sources are available perform an Incremental build, only \r
  echo                        build those updated tools.\r
  echo         ForceRebuild   If sources are available, rebuild all tools regardless of \r
  echo                        whether they have been updated or not.\r
  echo         Reconfig       Reinstall target.txt, tools_def.txt and build_rule.txt.\r
  echo.\r
  echo  JAVA/ANT Build\r
  echo         AntBuild       Using older Java/ANT build tools in Tools directory.\r
  echo         Rebuild        Incremental build, only build those updated tools.\r
  echo         ForceRebuild   Rebuild all tools regardless of whether they have been updated or not.\r
  echo         Reconfig       Reinstall target.txt, tools_def.txt and FrameworkDatabase.db.\r
  echo.\r
  echo  Note that target.template, tools_def.template, build_rules.template and the \r
  echo  FrameworkDatabase.template will be only copied to target.txt, tools_def.txt, build_rule.txt and\r
  echo  FrameworkDatabase.db respectively if they do not exist. Using option [Reconfig] to force the copy. \r
  echo.\r
  @goto end\r
\r
:end\r
  @popd\r
  @echo on\r
\r