public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
* [PATCH] FatPkg: Fix various typos
@ 2019-06-29 11:29 Cœur
  2019-07-04 13:08 ` [edk2-devel] " Leif Lindholm
  0 siblings, 1 reply; 2+ messages in thread
From: Cœur @ 2019-06-29 11:29 UTC (permalink / raw)
  To: devel

[-- Attachment #1: Type: text/plain, Size: 19035 bytes --]

Fix various typos in FatPkg.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Coeur <coeur@gmx.fr>
---
FatPkg/EnhancedFatDxe/Delete.c          |  2 +-
FatPkg/EnhancedFatDxe/DirectoryManage.c | 10 +++++-----
FatPkg/EnhancedFatDxe/Fat.c             |  2 +-
FatPkg/EnhancedFatDxe/Fat.h             | 24 ++++++++++++------------
FatPkg/EnhancedFatDxe/FileName.c        |  4 ++--
FatPkg/EnhancedFatDxe/FileSpace.c       |  8 ++++----
FatPkg/EnhancedFatDxe/Flush.c           |  2 +-
FatPkg/EnhancedFatDxe/Info.c            |  2 +-
FatPkg/EnhancedFatDxe/Init.c            |  2 +-
FatPkg/EnhancedFatDxe/Misc.c            |  6 +++---
FatPkg/EnhancedFatDxe/Open.c            |  2 +-
FatPkg/FatPei/FatLiteApi.c              |  6 +++---
FatPkg/FatPei/FatLitePeim.h             |  4 ++--
13 files changed, 37 insertions(+), 37 deletions(-)

diff --git a/FatPkg/EnhancedFatDxe/Delete.c b/FatPkg/EnhancedFatDxe/Delete.c
index b2a62b35de..8a437e3ee2 100644
--- a/FatPkg/EnhancedFatDxe/Delete.c
+++ b/FatPkg/EnhancedFatDxe/Delete.c
@@ -56,7 +56,7 @@ FatDelete (
goto Done;
}
//
-  // If the file has a permanant error, skip the delete
+  // If the file has a permanent error, skip the delete
//
Status = OFile->Error;
if (!EFI_ERROR (Status)) {
diff --git a/FatPkg/EnhancedFatDxe/DirectoryManage.c b/FatPkg/EnhancedFatDxe/DirectoryManage.c
index 21656883bd..90c01b3baa 100644
--- a/FatPkg/EnhancedFatDxe/DirectoryManage.c
+++ b/FatPkg/EnhancedFatDxe/DirectoryManage.c
@@ -13,11 +13,11 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
Get a directory entry from disk for the Ofile.

@param  Parent                - The parent of the OFile which need to update.
-  @param  IoMode                - Indicate whether to read directory entry or write directroy entry.
+  @param  IoMode                - Indicate whether to read directory entry or write directory entry.
@param  EntryPos              - The position of the directory entry to be accessed.
@param  Entry                 - The directory entry read or written.

-  @retval EFI_SUCCESS           - Access the directory entry sucessfully.
+  @retval EFI_SUCCESS           - Access the directory entry successfully.
@return other                 - An error occurred when reading the directory entry.

**/
@@ -896,7 +896,7 @@ FatNewEntryPos (
@param  Volume                - FAT file system volume.
@param  Name                  - The file name of the volume.

-  @retval EFI_SUCCESS           - Update the volume with the directory entry sucessfully.
+  @retval EFI_SUCCESS           - Update the volume with the directory entry successfully.
@return others                - An error occurred when getting volume label.

**/
@@ -927,7 +927,7 @@ FatGetVolumeEntry (
@param  Volume              - FAT file system volume.
@param  Name                - The new file name of the volume.

-  @retval EFI_SUCCESS         - Update the Volume sucessfully.
+  @retval EFI_SUCCESS         - Update the Volume successfully.
@retval EFI_UNSUPPORTED     - The input label is not a valid volume label.
@return other               - An error occurred when setting volume label.

@@ -1246,7 +1246,7 @@ FatCloseDirEnt (
not be created either).
@retval EFI_INVALID_PARAMETER - The parameter is not valid.
@retval EFI_SUCCESS           - Open the file successfully.
-  @return other                 - An error occured when locating the OFile.
+  @return other                 - An error occurred when locating the OFile.

**/
EFI_STATUS
diff --git a/FatPkg/EnhancedFatDxe/Fat.c b/FatPkg/EnhancedFatDxe/Fat.c
index 3bec1c94ec..77cda19539 100644
--- a/FatPkg/EnhancedFatDxe/Fat.c
+++ b/FatPkg/EnhancedFatDxe/Fat.c
@@ -417,7 +417,7 @@ FatDriverBindingStart (
Status = FatAllocateVolume (ControllerHandle, DiskIo, DiskIo2, BlockIo);

//
-  // When the media changes on a device it will Reinstall the BlockIo interaface.
+  // When the media changes on a device it will Reinstall the BlockIo interface.
// This will cause a call to our Stop(), and a subsequent reentrant call to our
// Start() successfully. We should leave the device open when this happen.
//
diff --git a/FatPkg/EnhancedFatDxe/Fat.h b/FatPkg/EnhancedFatDxe/Fat.h
index 98ead5a0fb..47358d4452 100644
--- a/FatPkg/EnhancedFatDxe/Fat.h
+++ b/FatPkg/EnhancedFatDxe/Fat.h
@@ -236,7 +236,7 @@ struct _FAT_OFILE {
UINTN               Signature;
FAT_VOLUME          *Volume;
//
-  // A permanant error code to return to all accesses to
+  // A permanent error code to return to all accesses to
// this opened file
//
EFI_STATUS          Error;
@@ -246,7 +246,7 @@ struct _FAT_OFILE {
LIST_ENTRY          Opens;

//
-  // The dynamic infomation
+  // The dynamic information
//
UINTN               FileSize;
UINTN               FileCluster;
@@ -865,7 +865,7 @@ FatCleanupVolume (

@param  OFile                 - The open file.

-  @retval EFI_SUCCESS           - Shrinked sucessfully.
+  @retval EFI_SUCCESS           - Shrinked successfully.
@retval EFI_VOLUME_CORRUPTED  - There are errors in the file's clusters.

**/
@@ -881,7 +881,7 @@ FatShrinkEof (
@param  OFile                 - The open file.
@param  NewSizeInBytes        - The new size in bytes of the open file.

-  @retval EFI_SUCCESS           - The file is grown sucessfully.
+  @retval EFI_SUCCESS           - The file is grown successfully.
@retval EFI_UNSUPPORTED       - The file size is larger than 4GB.
@retval EFI_VOLUME_CORRUPTED  - There are errors in the files' clusters.
@retval EFI_VOLUME_FULL       - The volume is full and can not grow the file.
@@ -969,7 +969,7 @@ FatComputeFreeInfo (
@param  Handle                - The handle of parent device.
@param  DiskIo                - The DiskIo of parent device.
@param  DiskIo2               - The DiskIo2 of parent device.
-  @param  BlockIo               - The BlockIo of parent devicel
+  @param  BlockIo               - The BlockIo of parent device.

@retval EFI_SUCCESS           - Allocate a new volume successfully.
@retval EFI_OUT_OF_RESOURCES  - Can not allocate the memory.
@@ -1079,7 +1079,7 @@ FatDestroySubtask (
@param  IFile                 - The instance of the open file.
@param  Task                  - The task to be executed.

-  @retval EFI_SUCCESS           - The task was executed sucessfully.
+  @retval EFI_SUCCESS           - The task was executed successfully.
@return other                 - An error occurred when executing the task.

**/
@@ -1097,7 +1097,7 @@ FatQueueTask (
@param  IoMode                - The access mode.
@param  DirtyValue            - Set the volume as dirty or not.

-  @retval EFI_SUCCESS           - Set the new FAT entry value sucessfully.
+  @retval EFI_SUCCESS           - Set the new FAT entry value successfully.
@return other                 - An error occurred when operation the FAT entries.

**/
@@ -1120,7 +1120,7 @@ FatAccessVolumeDirty (
@param  Task                    point to task instance.

@retval EFI_SUCCESS           - The operation is performed successfully.
-  @retval EFI_VOLUME_CORRUPTED  - The accesss is
+  @retval EFI_VOLUME_CORRUPTED  - The access is
@return Others                - The status of read/write the disk

**/
@@ -1710,7 +1710,7 @@ FatCloseDirEnt (
not be created either).
@retval EFI_INVALID_PARAMETER - The parameter is not valid.
@retval EFI_SUCCESS           - Open the file successfully.
-  @return other                 - An error occured when locating the OFile.
+  @return other                 - An error occurred when locating the OFile.

**/
EFI_STATUS
@@ -1728,7 +1728,7 @@ FatLocateOFile (
@param  Volume                - FAT file system volume.
@param  Name                  - The file name of the volume.

-  @retval EFI_SUCCESS           - Update the volume with the directory entry sucessfully.
+  @retval EFI_SUCCESS           - Update the volume with the directory entry successfully.
@return others                - An error occurred when getting volume label.

**/
@@ -1745,7 +1745,7 @@ FatGetVolumeEntry (
@param  Volume              - FAT file system volume.
@param  Name                - The new file name of the volume.

-  @retval EFI_SUCCESS         - Update the Volume sucessfully.
+  @retval EFI_SUCCESS         - Update the Volume successfully.
@retval EFI_UNSUPPORTED     - The input label is not a valid volume label.
@return other               - An error occurred when setting volume label.

@@ -1863,7 +1863,7 @@ FatCreate8Dot3Name (
@param  FatName               - The Char8 string needs to be converted.
@param  Len                   - The length of the fat name.
@param  LowerCase             - Indicate whether to convert the string to lower case.
-  @param  Str                   - The result of the convertion.
+  @param  Str                   - The result of the conversion.

**/
VOID
diff --git a/FatPkg/EnhancedFatDxe/FileName.c b/FatPkg/EnhancedFatDxe/FileName.c
index bab709d964..d2d1fb3117 100644
--- a/FatPkg/EnhancedFatDxe/FileName.c
+++ b/FatPkg/EnhancedFatDxe/FileName.c
@@ -100,7 +100,7 @@ FatCheckIs8Dot3Name (

Trim the trailing blanks of fat name.

-  @param  Name                  - The Char8 string needs to be trimed.
+  @param  Name                  - The Char8 string needs to be trimmed.
@param  Len                   - The length of the fat name.

The real length of the fat name after the trailing blanks are trimmed.
@@ -128,7 +128,7 @@ FatTrimAsciiTrailingBlanks (
@param  FatName               - The Char8 string needs to be converted.
@param  Len                   - The length of the fat name.
@param  LowerCase             - Indicate whether to convert the string to lower case.
-  @param  Str                   - The result of the convertion.
+  @param  Str                   - The result of the conversion.

**/
VOID
diff --git a/FatPkg/EnhancedFatDxe/FileSpace.c b/FatPkg/EnhancedFatDxe/FileSpace.c
index 6659036039..a9d46fed74 100644
--- a/FatPkg/EnhancedFatDxe/FileSpace.c
+++ b/FatPkg/EnhancedFatDxe/FileSpace.c
@@ -129,7 +129,7 @@ FatGetFatEntry (
@param  Index                 - The index of the FAT entry of the volume.
@param  Value                 - The new value of the FAT entry.

-  @retval EFI_SUCCESS           - Set the new FAT entry value sucessfully.
+  @retval EFI_SUCCESS           - Set the new FAT entry value successfully.
@retval EFI_VOLUME_CORRUPTED  - The FAT type of the volume is error.
@return other                 - An error occurred when operation the FAT entries.

@@ -223,7 +223,7 @@ FatSetFatEntry (

/**

-  Free the cluster clain.
+  Free the cluster chain.

@param  Volume                - FAT file system volume.
@param  Cluster               - The first cluster of cluster chain.
@@ -343,7 +343,7 @@ FatSizeToClusters (

@param  OFile                 - The open file.

-  @retval EFI_SUCCESS           - Shrinked sucessfully.
+  @retval EFI_SUCCESS           - Shrinked successfully.
@retval EFI_VOLUME_CORRUPTED  - There are errors in the file's clusters.

**/
@@ -416,7 +416,7 @@ FatShrinkEof (
@param  OFile                 - The open file.
@param  NewSizeInBytes        - The new size in bytes of the open file.

-  @retval EFI_SUCCESS           - The file is grown sucessfully.
+  @retval EFI_SUCCESS           - The file is grown successfully.
@retval EFI_UNSUPPORTED       - The file size is larger than 4GB.
@retval EFI_VOLUME_CORRUPTED  - There are errors in the files' clusters.
@retval EFI_VOLUME_FULL       - The volume is full and can not grow the file.
diff --git a/FatPkg/EnhancedFatDxe/Flush.c b/FatPkg/EnhancedFatDxe/Flush.c
index e88557d77c..59b5014c73 100644
--- a/FatPkg/EnhancedFatDxe/Flush.c
+++ b/FatPkg/EnhancedFatDxe/Flush.c
@@ -226,7 +226,7 @@ FatOFileFlush (
//
do {
//
-    // If the file has a permanant error, then don't write any
+    // If the file has a permanent error, then don't write any
// of its data to the device (may be from different media)
//
if (EFI_ERROR (OFile->Error)) {
diff --git a/FatPkg/EnhancedFatDxe/Info.c b/FatPkg/EnhancedFatDxe/Info.c
index 1c9811cad0..fd4c0278f9 100644
--- a/FatPkg/EnhancedFatDxe/Info.c
+++ b/FatPkg/EnhancedFatDxe/Info.c
@@ -407,7 +407,7 @@ FatSetFileInfo (
//
if (OFile->ODir != NULL) {
//
-      // Syncronize its dot entry
+      // Synchronize its dot entry
//
FatResetODirCursor (OFile);
ASSERT (OFile->Parent != NULL);
diff --git a/FatPkg/EnhancedFatDxe/Init.c b/FatPkg/EnhancedFatDxe/Init.c
index 530154bd25..4e6bd9d0fd 100644
--- a/FatPkg/EnhancedFatDxe/Init.c
+++ b/FatPkg/EnhancedFatDxe/Init.c
@@ -16,7 +16,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
@param  Handle                - The handle of parent device.
@param  DiskIo                - The DiskIo of parent device.
@param  DiskIo2               - The DiskIo2 of parent device.
-  @param  BlockIo               - The BlockIo of parent devicel
+  @param  BlockIo               - The BlockIo of parent device.

@retval EFI_SUCCESS           - Allocate a new volume successfully.
@retval EFI_OUT_OF_RESOURCES  - Can not allocate the memory.
diff --git a/FatPkg/EnhancedFatDxe/Misc.c b/FatPkg/EnhancedFatDxe/Misc.c
index bc19695fc9..a005036d46 100644
--- a/FatPkg/EnhancedFatDxe/Misc.c
+++ b/FatPkg/EnhancedFatDxe/Misc.c
@@ -114,7 +114,7 @@ FatDestroySubtask (
@param  IFile                 - The instance of the open file.
@param  Task                  - The task to be executed.

-  @retval EFI_SUCCESS           - The task was executed sucessfully.
+  @retval EFI_SUCCESS           - The task was executed successfully.
@return other                 - An error occurred when executing the task.

**/
@@ -219,7 +219,7 @@ FatQueueTask (
@param  IoMode                - The access mode.
@param  DirtyValue            - Set the volume as dirty or not.

-  @retval EFI_SUCCESS           - Set the new FAT entry value sucessfully.
+  @retval EFI_SUCCESS           - Set the new FAT entry value successfully.
@return other                 - An error occurred when operation the FAT entries.

**/
@@ -304,7 +304,7 @@ FatOnAccessComplete (
@param  Task                    point to task instance.

@retval EFI_SUCCESS           - The operation is performed successfully.
-  @retval EFI_VOLUME_CORRUPTED  - The accesss is
+  @retval EFI_VOLUME_CORRUPTED  - The access is
@return Others                - The status of read/write the disk

**/
diff --git a/FatPkg/EnhancedFatDxe/Open.c b/FatPkg/EnhancedFatDxe/Open.c
index cfd99baf7d..1b716e0cdf 100644
--- a/FatPkg/EnhancedFatDxe/Open.c
+++ b/FatPkg/EnhancedFatDxe/Open.c
@@ -74,7 +74,7 @@ FatAllocateIFile (
@retval EFI_SUCCESS           - Open the file successfully.
@retval EFI_INVALID_PARAMETER - The open mode is conflict with the attributes
or the file name is not valid.
-  @retval EFI_NOT_FOUND         - Conficts between dir intention and attribute.
+  @retval EFI_NOT_FOUND         - Conflicts between dir intention and attribute.
@retval EFI_WRITE_PROTECTED   - Can't open for write if the volume is read only.
@retval EFI_ACCESS_DENIED     - If the file's attribute is read only, and the
open is for read-write fail it.
diff --git a/FatPkg/FatPei/FatLiteApi.c b/FatPkg/FatPei/FatLiteApi.c
index b9f883b9e0..69487615b7 100644
--- a/FatPkg/FatPei/FatLiteApi.c
+++ b/FatPkg/FatPei/FatLiteApi.c
@@ -12,7 +12,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
PEI_FAT_PRIVATE_DATA  *mPrivateData = NULL;

/**
-  BlockIo installation nofication function. Find out all the current BlockIO
+  BlockIo installation notification function. Find out all the current BlockIO
PPIs in the system and add them into private data. Assume there is

@param  PeiServices             General purpose services available to every
@@ -591,7 +591,7 @@ LoadRecoveryCapsule (

/**
Finds the recovery file on a FAT volume.
-  This function finds the the recovery file named FileName on a specified FAT volume and returns
+  This function finds the recovery file named FileName on a specified FAT volume and returns
its FileHandle pointer.

@param  PrivateData             Global memory map for accessing global
@@ -600,7 +600,7 @@ LoadRecoveryCapsule (
@param  FileName                The recovery file name to find.
@param  Handle                  The output file handle.

-  @retval EFI_DEVICE_ERROR        Some error occured when operating the FAT
+  @retval EFI_DEVICE_ERROR        Some error occurred when operating the FAT
volume.
@retval EFI_NOT_FOUND           The recovery file was not found.
@retval EFI_SUCCESS             The recovery file was successfully found on the
diff --git a/FatPkg/FatPei/FatLitePeim.h b/FatPkg/FatPei/FatLitePeim.h
index 18534b9abb..9159edd677 100644
--- a/FatPkg/FatPei/FatLitePeim.h
+++ b/FatPkg/FatPei/FatLitePeim.h
@@ -185,7 +185,7 @@ typedef struct {

/**
Finds the recovery file on a FAT volume.
-  This function finds the the recovery file named FileName on a specified FAT volume and returns
+  This function finds the recovery file named FileName on a specified FAT volume and returns
its FileHandle pointer.

@param  PrivateData             Global memory map for accessing global
@@ -194,7 +194,7 @@ typedef struct {
@param  FileName                The recovery file name to find.
@param  Handle                  The output file handle.

-  @retval EFI_DEVICE_ERROR        Some error occured when operating the FAT
+  @retval EFI_DEVICE_ERROR        Some error occurred when operating the FAT
volume.
@retval EFI_NOT_FOUND           The recovery file was not found.
@retval EFI_SUCCESS             The recovery file was successfully found on the
--
2.20.1 (Apple Git-117)

[-- Attachment #2: Type: text/html, Size: 31438 bytes --]

^ permalink raw reply related	[flat|nested] 2+ messages in thread
end of thread, other threads:[~2019-07-04 13:08 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-06-29 11:29 [PATCH] FatPkg: Fix various typos Cœur
2019-07-04 13:08 ` [edk2-devel] " Leif Lindholm

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox