audk/edksetup.sh
Paolo Bonzini d54934498f edksetup.sh: Ensure that WORKSPACE points to the top of an edk2 checkout
Since WORKSPACE should point at the EDK2 tree, the right place
to check its validity is edksetup.sh, not BaseTools/BuildEnv.

This patch makes sure that BuildEnv is always invoked with a valid
WORKSPACE.  This lets us show better error messages, and ensures that
we never dirty the user's environment.

BuildEnv will maintain backwards-compatibility and, should the variable
be missing, it will be able to set a default WORKSPACE.  Only the sanity
checks will be of lower quality.

Note that the error message in SetupEnv will never be shown if
SetWorkspace sets WORKSPACE=`pwd`.

Suggested-by: Laszlo Ersek <lersek@redhat.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15701 6f19259b-4bc3-4df7-8a09-765794883524
2014-07-28 17:37:40 +00:00

121 lines
3.0 KiB
Bash
Executable File

#
# 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
#
function HelpMsg()
{
echo Please note: This script must be \'sourced\' so the environment can be changed.
echo ". edksetup.sh"
echo "source edksetup.sh"
return 1
}
function SetWorkspace()
{
#
# If WORKSPACE is already set, then we can return right now
#
if [ -n "$WORKSPACE" ]
then
return 0
fi
if [ ! ${BASH_SOURCE[0]} -ef ./edksetup.sh ]
then
echo Run this script from the base of your tree. For example:
echo " cd /Path/To/Edk/Root"
echo " . edksetup.sh"
return 1
fi
#
# Check for BaseTools/BuildEnv before dirtying the user's environment.
#
if [ ! -f BaseTools/BuildEnv ] && [ -z "$EDK_TOOLS_PATH" ]
then
echo BaseTools not found in your tree, and EDK_TOOLS_PATH is not set.
echo Please point EDK_TOOLS_PATH at the directory that contains
echo the EDK2 BuildEnv script.
return 1
fi
#
# Set $WORKSPACE
#
export WORKSPACE=`pwd`
return 0
}
function SetupEnv()
{
if [ -n "$EDK_TOOLS_PATH" ]
then
. $EDK_TOOLS_PATH/BuildEnv $*
elif [ -f "$WORKSPACE/BaseTools/BuildEnv" ]
then
. $WORKSPACE/BaseTools/BuildEnv $*
else
echo BaseTools not found in your tree, and EDK_TOOLS_PATH is not set.
echo Please check that WORKSPACE is not set incorrectly in your
echo shell, or point EDK_TOOLS_PATH at the directory that contains
echo the EDK2 BuildEnv script.
return 1
fi
}
function SourceEnv()
{
if [ \
"$1" = "-?" -o \
"$1" = "-h" -o \
"$1" = "--help" \
]
then
HelpMsg
else
SetWorkspace &&
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 "$*"