Reviewed-by: Jaben Carsey <jaben.car...@intel.com> > -----Original Message----- > From: Qiu, Shumin > Sent: Thursday, June 11, 2015 7:18 PM > To: edk2-devel@lists.sourceforge.net > Cc: Carsey, Jaben; Gao, Liming; Tian, Hot > Subject: [PATCH] MdePkg: Refine the comments for FileHandleIsDirectory. > Importance: High > > Make the function comments of FileHandleIsDirectory in FileHandleLib > consistent with instance implementation. > > Contributed-under: TianoCore Contribution Agreement 1.0 > Signed-off-by: Qiu Shumin <shumin....@intel.com> > --- > MdePkg/Include/Library/FileHandleLib.h | 4 ++-- > MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c | 7 ++++--- > 2 files changed, 6 insertions(+), 5 deletions(-) > > diff --git a/MdePkg/Include/Library/FileHandleLib.h > b/MdePkg/Include/Library/FileHandleLib.h > index 123cc8c..9c2d056 100644 > --- a/MdePkg/Include/Library/FileHandleLib.h > +++ b/MdePkg/Include/Library/FileHandleLib.h > @@ -1,7 +1,7 @@ > /** @file > Provides interface to EFI_FILE_HANDLE functionality. > > - Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR> > + Copyright (c) 2009 - 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 @@ -242,7 +242,7 @@ FileHandleFlush ( > /** > Function to determine if a given handle is a directory handle. > > - If DirHandle is NULL, then ASSERT(). > + If DirHandle is NULL then return EFI_INVALID_PARAMETER. > > Open the file information on the DirHandle, and verify that the Attribute > includes EFI_FILE_DIRECTORY bit set. > diff --git a/MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c > b/MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c > index be66c57..089f610 100644 > --- a/MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c > +++ b/MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c > @@ -1,7 +1,7 @@ > /** @file > Provides interface to EFI_FILE_HANDLE functionality. > > - 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 @@ -385,7 +385,7 @@ FileHandleFlush ( > /** > function to determine if a given handle is a directory handle > > - if DirHandle is NULL then return error > + If DirHandle is NULL then return EFI_INVALID_PARAMETER > > open the file information on the DirHandle and verify that the Attribute > includes EFI_FILE_DIRECTORY bit set. > @@ -393,7 +393,8 @@ FileHandleFlush ( > @param DirHandle Handle to open file > > @retval EFI_SUCCESS DirHandle is a directory > - @retval EFI_INVALID_PARAMETER DirHandle did not have EFI_FILE_INFO > available > + @retval EFI_INVALID_PARAMETER DirHandle is NULL or the file > information > + returns from FileHandleGetInfo is NULL > @retval EFI_NOT_FOUND DirHandle is not a directory > **/ > EFI_STATUS > -- > 1.9.5.msysgit.1 >
------------------------------------------------------------------------------ _______________________________________________ edk2-devel mailing list edk2-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/edk2-devel