Comment's added and fixed.
[mirror_edk2.git] / edksetup.sh
1 #
2 # Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
3 # This program and the accompanying materials
4 # are licensed and made available under the terms and conditions of the BSD License
5 # which accompanies this distribution.  The full text of the license may be found at
6 # http://opensource.org/licenses/bsd-license.php
7
8 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
9 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
10 #
11 # In *inux environment, the build tools's source is required and need to be compiled
12 # firstly, please reference https://edk2.tianocore.org/unix-getting-started.html to 
13 # to get how to setup build tool.
14 #
15 # After build tool is downloaded and compiled, a soft symbol linker need to be created
16 # at <workspace>/Conf. For example: ln -s /work/BaseTools /work/edk2/Conf/BaseToolsSource.
17 #
18 # Setup the environment for unix-like systems running a bash-like shell.
19 # This file must be "sourced" not merely executed. For example: ". edksetup.sh"
20 #
21 # CYGWIN users: Your path and filename related environment variables should be
22 # set up in the unix style.  This script will make the necessary conversions to
23 # windows style.
24 #
25 # Please reference edk2 user manual for more detail descriptions at https://edk2.tianocore.org/files/documents/64/494/EDKII_UserManual.pdf
26 #
27
28 if [ \
29      "$1" = "-?" -o \
30      "$1" = "-h" -o \
31      "$1" = "--help" \
32    ]
33 then
34   echo BaseTools Usage: \'. edksetup.sh\'
35   echo
36   echo Please note: This script must be \'sourced\' so the environment can be changed.
37   echo \(Either \'. edksetup.sh\' or \'source edksetup.sh\'\)
38   return
39 fi
40
41 if [ -z "$WORKSPACE" ]
42 then
43   . BaseTools/BuildEnv $*
44 else
45   . $WORKSPACE/BaseTools/BuildEnv $*
46 fi
47
48