Report the setting variable failure to platform through the status code when core...

[mirror_edk2.git] / edksetup.sh

diff --git a/edksetup.sh b/edksetup.sh
old mode 100644 (file)
new mode 100755 (executable)
index 323b0f3..0b7e33f
--- a/edksetup.sh
+++ b/edksetup.sh
@@ -1,59 +1,75 @@
 #
-# Copyright (c) 2006 - 2008, Intel Corporation
-# All rights reserved. This program and the accompanying materials
+# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
+# This program and the accompanying materials
 # are licensed and made available under the terms and conditions of the BSD License
 # which accompanies this distribution.  The full text of the license may be found at
 # http://opensource.org/licenses/bsd-license.php
 # 
 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
+#
+# In *inux environment, the build tools's source is required and need to be compiled
+# firstly, please reference https://edk2.tianocore.org/unix-getting-started.html to 
+# to get how to setup build tool.
+#
+# After build tool is downloaded and compiled, a soft symbol linker need to be created
+# at <workspace>/Conf. For example: ln -s /work/BaseTools /work/edk2/Conf/BaseToolsSource.
+#
 # Setup the environment for unix-like systems running a bash-like shell.
 # This file must be "sourced" not merely executed. For example: ". edksetup.sh"
-
+#
 # CYGWIN users: Your path and filename related environment variables should be
 # set up in the unix style.  This script will make the necessary conversions to
 # windows style.
+#
+# Please reference edk2 user manual for more detail descriptions at https://edk2.tianocore.org/files/documents/64/494/EDKII_UserManual.pdf
+#
 
-if [ \
-     -z "$1" -o \
-     "$1" = "-?" -o \
-     "$1" = "-h" -o \
-     "$1" = "--help" \
-   ]
-then
-  echo BaseTools Usage: \'. edksetup.sh BaseTools\'
-  echo Ant Tools Usage: \'. edksetup.sh [AntBuild \| ForceRebuild]\'
-  echo
+function HelpMsg()
+{
   echo Please note: This script must be \'sourced\' so the environment can be changed.
-  echo \(Either \'. edksetup.sh\' or \'source edksetup.sh\'\)
-  return
-fi
+  echo ". edksetup.sh" 
+  echo "source edksetup.sh"
+  return 1
+}
 
-if [ "$1" = BaseTools ]
-then
+function SetupEnv()
+{
   if [ -z "$WORKSPACE" ]
   then
     . BaseTools/BuildEnv $*
   else
     . $WORKSPACE/BaseTools/BuildEnv $*
   fi
-else
-  if [ "$1" = AntBuild -o "$1" = ForceRebuild ]
+}
+
+function SourceEnv()
+{
+  if [ \
+       "$1" = "-?" -o \
+       "$1" = "-h" -o \
+       "$1" = "--help" \
+     ]
   then
-    if [ -z "$WORKSPACE" ]
-    then
-      if [ "$1" = AntBuild ]
-      then
-        shift
-      fi
-      . Tools/OldBuildEnv $*
-    else
-      . $WORKSPACE/Tools/OldBuildEnv $*
-    fi
+    HelpMsg
   else
-    echo Please run \'. edksetup.sh --help\' for help.
+    SetupEnv "$*"
   fi
+}
+
+if [ $# -gt 1 ]
+then
+  HelpMsg
+elif [ $# -eq 1 ] && [ "$1" != "BaseTools" ]
+then
+  HelpMsg
+fi
+
+RETVAL=$?
+if [ $RETVAL -ne 0 ]
+then
+  return $RETVAL
 fi
 
+SourceEnv "$*"