It is possible to source edksetup.sh from another script. If the
sourcing script has any set positional parameters that are not supported
by edksetup.sh, the help section is always shown. This patch updates
the help section informing the user about these possible unsupported set
positional parameters, so that, they can be unset prior to sourcing
edksetup.sh.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Arvind Prasanna <arvindprasanna@gmail.com>

Changes in v3:
- Modify the help section to cover only unsupported positional parameters.
- Adapt commit message to the change in the above line

Changes in v2:
- Fixed a typo.
- Minor rewording.
---
 edksetup.sh | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/edksetup.sh b/edksetup.sh
index 93d6525..6a590df 100755
--- a/edksetup.sh
+++ b/edksetup.sh
@@ -42,6 +42,8 @@ function HelpMsg()
   echo Please note: This script must be \'sourced\' so the environment can be changed.
   echo ". $SCRIPTNAME"
   echo "source $SCRIPTNAME"
+  echo "If this script is being sourced from another script, the sourcing script"
+  echo "should have no set positional parameters unsupported by this script."
 }
 
 function SetWorkspace()
-- 
2.7.4

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel