From: jcarsey <jcarsey@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Thu, 19 Nov 2009 19:53:58 +0000 (+0000)
Subject: fixing errors found in code review.
X-Git-Tag: edk2-stable201903~16869
X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=ef34de257bd1956c1f6e6f93ba7dda64b17a41ea

fixing errors found in code review.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9450 6f19259b-4bc3-4df7-8a09-765794883524
---

diff --git a/ShellPkg/Include/Guid/ShellEnvironment2Ext.h b/ShellPkg/Include/Guid/ShellEnvironment2Ext.h
index 49770057be..b0899c27a2 100644
--- a/ShellPkg/Include/Guid/ShellEnvironment2Ext.h
+++ b/ShellPkg/Include/Guid/ShellEnvironment2Ext.h
@@ -18,7 +18,7 @@
 #define SHELLPKG_SHELL_ENV2_EXT_GUID \
 { \
   0xd2c18636, 0x40e5, 0x4eb5, {0xa3, 0x1b, 0x36, 0x69, 0x5f, 0xd4, 0x2c, 0x87} \
-};
+}
 
 extern EFI_GUID gEfiShellEnvironment2ExtGuid;
 
diff --git a/ShellPkg/Include/Protocol/EfiShell.h b/ShellPkg/Include/Protocol/EfiShell.h
index 8b489dac6b..11ee58a75c 100644
--- a/ShellPkg/Include/Protocol/EfiShell.h
+++ b/ShellPkg/Include/Protocol/EfiShell.h
@@ -26,12 +26,12 @@
 // replaced EFI_LIST_ENTRY with LIST_ENTRY for simplicity.
 // they are identical outside of the name.
 typedef struct {
-  LIST_ENTRY Link;          /// Linked list members
-  EFI_STATUS Status;        /// Status of opening the file.  Valid only if Handle != NULL.
-  CONST CHAR16 *FullName;   /// Fully qualified filename.
-  CONST CHAR16 *FileName;   /// name of this file.
-  EFI_FILE_HANDLE Handle;   /// Handle for interacting with the opened file or NULL if closed.
-  EFI_FILE_INFO *Info;      /// Pointer to the FileInfo struct for this file or NULL.
+  LIST_ENTRY Link;          ///< Linked list members
+  EFI_STATUS Status;        ///< Status of opening the file.  Valid only if Handle != NULL.
+  CONST CHAR16 *FullName;   ///< Fully qualified filename.
+  CONST CHAR16 *FileName;   ///< name of this file.
+  EFI_FILE_HANDLE Handle;   ///< Handle for interacting with the opened file or NULL if closed.
+  EFI_FILE_INFO *Info;      ///< Pointer to the FileInfo struct for this file or NULL.
 } EFI_SHELL_FILE_INFO;
 /**
   Returns whether any script files are currently being processed.
diff --git a/ShellPkg/Include/Protocol/EfiShellParameters.h b/ShellPkg/Include/Protocol/EfiShellParameters.h
index 49ad2fdc43..8f6658b6b5 100644
--- a/ShellPkg/Include/Protocol/EfiShellParameters.h
+++ b/ShellPkg/Include/Protocol/EfiShellParameters.h
@@ -21,10 +21,35 @@
   }
 
 typedef struct _EFI_SHELL_PARAMETERS_PROTOCOL {
+///
+/// Points to an Argc-element array of points to null-terminated strings containing
+/// the command-line parameters. The first entry in the array is always the full file
+/// path of the executable. Any quotation marks that were used to preserve
+/// whitespace have been removed.
+///
   CHAR16 **Argv;
+
+///
+/// The number of elements in the Argv array.
+/// 
   UINTN Argc;
+
+///
+/// The file handle for the standard input for this executable. This may be different
+/// from the ConInHandle in the EFI_SYSTEM_TABLE.
+///
   EFI_FILE_HANDLE StdIn;
+
+///
+/// The file handle for the standard output for this executable. This may be different
+/// from the ConOutHandle in the EFI_SYSTEM_TABLE.
+///
   EFI_FILE_HANDLE StdOut;
+
+///
+/// The file handle for the standard error output for this executable. This may be
+/// different from the StdErrHandle in the EFI_SYSTEM_TABLE.
+///
   EFI_FILE_HANDLE StdErr;
 } EFI_SHELL_PARAMETERS_PROTOCOL;
 
diff --git a/ShellPkg/Include/ShellBase.h b/ShellPkg/Include/ShellBase.h
index 3929df7b77..d5f0b03eec 100644
--- a/ShellPkg/Include/ShellBase.h
+++ b/ShellPkg/Include/ShellBase.h
@@ -138,9 +138,10 @@ SHELL_INCOMPATIBLE_VERSION  = 25,
 SHELL_SECURITY_VIOLATION    = 26,
 
 ///
-/// A CRC error was detected.
+/// The function was performed and resulted in an unequal
+/// comparison..
 ///
-SHELL_CRC_ERROR             = 27
+SHELL_NOT_EQUAL             = 27
 }SHELL_STATUS;
 
 #endif //__SHELL_BASE__
\ No newline at end of file