summaryrefslogtreecommitdiffstats
path: root/ShellPkg/Include
diff options
context:
space:
mode:
authorQiu Shumin <shumin.qiu@intel.com>2015-10-23 02:03:20 +0000
committershenshushi <shenshushi@Edk2>2015-10-23 02:03:20 +0000
commitfbd2dfadfe6fb16ab7b49fca3764e05e65d97b8a (patch)
tree62be65e0eb87049beeb36b8ac95c2f127ce13c72 /ShellPkg/Include
parenta7e173b07a1ef336fc8d753cf85ae8473e92365a (diff)
downloadedk2-fbd2dfadfe6fb16ab7b49fca3764e05e65d97b8a.tar.gz
edk2-fbd2dfadfe6fb16ab7b49fca3764e05e65d97b8a.tar.bz2
edk2-fbd2dfadfe6fb16ab7b49fca3764e05e65d97b8a.zip
ShellPkg: Follow spec to remove the last '\' char in return name of GetCurDir().
In Shell spec 2.1 the return name of EFI_SHELL_PROTOCOL.GetCurDir() is defined as 'fs0:\current-dir' while in current implementation it's 'fs0:\current-dir\'. To follow spec the patch removed the redundant '\' char. Since it has been broken for a long time, some codes may depend on the broken behavior. After this change 'EFI_SHELL_PROTOCOL.GetCurDir()' and 'UefiShellLib.ShellGetCurrentDir()' will return a current directory string without tailing '\' (fs0:\current-dir), the value of Shell environment variable 'cwd' will become 'fs0:\current-dir' as well. This patch has updated all the code in EDKII to make them depend on the new behavior. Developers should check whether 'GetCurDir()' and 'ShellGetCurrentDir' are used in their source code. Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Qiu Shumin <shumin.qiu@intel.com> Reviewed-by: Jaben Carsey <jaben.carsey@intel.com> git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@18653 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'ShellPkg/Include')
-rw-r--r--ShellPkg/Include/Library/ShellLib.h4
-rw-r--r--ShellPkg/Include/Protocol/EfiShell.h4
2 files changed, 6 insertions, 2 deletions
diff --git a/ShellPkg/Include/Library/ShellLib.h b/ShellPkg/Include/Library/ShellLib.h
index 23da4eeaf6..d02d6e9de1 100644
--- a/ShellPkg/Include/Library/ShellLib.h
+++ b/ShellPkg/Include/Library/ShellLib.h
@@ -1,7 +1,7 @@
/** @file
Provides interface to shell functionality for shell commands and applications.
- Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2015, 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
@@ -550,6 +550,8 @@ ShellExecute (
name. If the DeviceName is not NULL, it returns the current directory name
on specified drive.
+ Note that the current directory string should exclude the tailing backslash character.
+
@param[in] DeviceName The name of the file system to get directory on.
@retval NULL The directory does not exist.
diff --git a/ShellPkg/Include/Protocol/EfiShell.h b/ShellPkg/Include/Protocol/EfiShell.h
index 6c1d66a669..5c7f4f6357 100644
--- a/ShellPkg/Include/Protocol/EfiShell.h
+++ b/ShellPkg/Include/Protocol/EfiShell.h
@@ -2,7 +2,7 @@
EFI Shell protocol as defined in the UEFI Shell 2.0 specification including errata.
(C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>
- Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2015, 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
@@ -294,6 +294,8 @@ EFI_STATUS
FileSystemMapping. In both cases, the returned name includes the file system
mapping (i.e. fs0:\current-dir).
+ Note that the current directory string should exclude the tailing backslash character.
+
@param[in] FileSystemMapping A pointer to the file system mapping. If NULL,
then the current working directory is returned.