[edk2-devel] [PATCH v2 27/78] MdePkg/Ppi: Fix various typos

Philippe Mathieu-Daudé posted 78 patches 6 years, 1 month ago
There is a newer version of this series
[edk2-devel] [PATCH v2 27/78] MdePkg/Ppi: Fix various typos
Posted by Philippe Mathieu-Daudé 6 years, 1 month ago
From: Antoine Coeur <coeur@gmx.fr>

Fix various typos in comments and documentation.

Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
---
 MdePkg/Include/Ppi/BlockIo.h              | 4 ++--
 MdePkg/Include/Ppi/BlockIo2.h             | 2 +-
 MdePkg/Include/Ppi/Capsule.h              | 2 +-
 MdePkg/Include/Ppi/Decompress.h           | 2 +-
 MdePkg/Include/Ppi/DeviceRecoveryModule.h | 2 +-
 MdePkg/Include/Ppi/IsaHc.h                | 2 +-
 MdePkg/Include/Ppi/MpServices.h           | 2 +-
 MdePkg/Include/Ppi/Pcd.h                  | 4 ++--
 MdePkg/Include/Ppi/RecoveryModule.h       | 2 +-
 MdePkg/Include/Ppi/TemporaryRamDone.h     | 2 +-
 MdePkg/Include/Ppi/VectorHandoffInfo.h    | 2 +-
 11 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/MdePkg/Include/Ppi/BlockIo.h b/MdePkg/Include/Ppi/BlockIo.h
index 524f026fe589..3a4955be6b59 100644
--- a/MdePkg/Include/Ppi/BlockIo.h
+++ b/MdePkg/Include/Ppi/BlockIo.h
@@ -15,7 +15,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 
   @par Revision Reference:
   This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 1:
-  Pre-EFI Initalization Core Interface.
+  Pre-EFI Initialization Core Interface.
 
 **/
 
@@ -58,7 +58,7 @@ typedef enum {
 /// Specification inconsistency here:
 /// PEI_BLOCK_IO_MEDIA has been changed to EFI_PEI_BLOCK_IO_MEDIA.
 /// Inconsistency exists in UEFI Platform Initialization Specification 1.2
-/// Volume 1: Pre-EFI Initalization Core Interface, where all referrences to
+/// Volume 1: Pre-EFI Initialization Core Interface, where all references to
 /// this structure name are with the "EFI_" prefix, except for the definition
 /// which is without "EFI_".  So the name of PEI_BLOCK_IO_MEDIA is taken as the
 /// exception, and EFI_PEI_BLOCK_IO_MEDIA is used to comply with most of
diff --git a/MdePkg/Include/Ppi/BlockIo2.h b/MdePkg/Include/Ppi/BlockIo2.h
index e1af6a4293ed..0dba6485d941 100644
--- a/MdePkg/Include/Ppi/BlockIo2.h
+++ b/MdePkg/Include/Ppi/BlockIo2.h
@@ -7,7 +7,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 
   @par Revision Reference:
   This PPI is defined in UEFI Platform Initialization Specification 1.4 Volume 1:
-  Pre-EFI Initalization Core Interface.
+  Pre-EFI Initialization Core Interface.
 
 **/
 
diff --git a/MdePkg/Include/Ppi/Capsule.h b/MdePkg/Include/Ppi/Capsule.h
index cb7b0e2ae76a..331d9b81cad2 100644
--- a/MdePkg/Include/Ppi/Capsule.h
+++ b/MdePkg/Include/Ppi/Capsule.h
@@ -45,7 +45,7 @@ typedef struct _EFI_PEI_CAPSULE_PPI PEI_CAPSULE_PPI;
                             On output, this variable will contain the size of the
                             coalesced capsule.
 
-  @retval EFI_NOT_FOUND          If: boot modecould not be determined, or the
+  @retval EFI_NOT_FOUND          If: boot mode could not be determined, or the
                                  boot mode is not flash-update, or the capsule descriptors were not found.
   @retval EFI_BUFFER_TOO_SMALL   The capsule could not be coalesced in the provided memory region.
   @retval EFI_SUCCESS            There was no capsule, or the capsule was processed successfully.
diff --git a/MdePkg/Include/Ppi/Decompress.h b/MdePkg/Include/Ppi/Decompress.h
index 7ba26e419c59..b9ca63746ab2 100644
--- a/MdePkg/Include/Ppi/Decompress.h
+++ b/MdePkg/Include/Ppi/Decompress.h
@@ -1,5 +1,5 @@
 /** @file
-  Provides decompression services to the PEI Foundatoin.
+  Provides decompression services to the PEI Foundation.
 
   Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
   SPDX-License-Identifier: BSD-2-Clause-Patent
diff --git a/MdePkg/Include/Ppi/DeviceRecoveryModule.h b/MdePkg/Include/Ppi/DeviceRecoveryModule.h
index a4587255a3c8..64dabec1139c 100644
--- a/MdePkg/Include/Ppi/DeviceRecoveryModule.h
+++ b/MdePkg/Include/Ppi/DeviceRecoveryModule.h
@@ -15,7 +15,7 @@
 
   @par Revision Reference:
   This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 1:
-  Pre-EFI Initalization Core Interface
+  Pre-EFI Initialization Core Interface
 
 **/
 
diff --git a/MdePkg/Include/Ppi/IsaHc.h b/MdePkg/Include/Ppi/IsaHc.h
index 5468c2e94b72..d7dfd9b47e8c 100644
--- a/MdePkg/Include/Ppi/IsaHc.h
+++ b/MdePkg/Include/Ppi/IsaHc.h
@@ -28,7 +28,7 @@ typedef struct _EFI_ISA_HC_PPI *PEFI_ISA_HC_PPI;
   that more than one caller may be assigned to the same aperture.
   It may be possible that a single hardware aperture may be used for more than
   one device. This function tracks the number of times that each aperture is
-  referenced, and doesa not close the hardware aperture (via CloseIoAperture())
+  referenced, and does not close the hardware aperture (via CloseIoAperture())
   until there are no more references to it.
 
   @param This             A pointer to this instance of the EFI_ISA_HC_PPI.
diff --git a/MdePkg/Include/Ppi/MpServices.h b/MdePkg/Include/Ppi/MpServices.h
index afcd8819e9cc..5ea3373909e1 100644
--- a/MdePkg/Include/Ppi/MpServices.h
+++ b/MdePkg/Include/Ppi/MpServices.h
@@ -75,7 +75,7 @@ EFI_STATUS
   );
 
 /**
-  Activate all of the application proessors.
+  Activate all of the application processors.
 
   @param[in] PeiServices          An indirect pointer to the PEI Services Table
                                   published by the PEI Foundation.
diff --git a/MdePkg/Include/Ppi/Pcd.h b/MdePkg/Include/Ppi/Pcd.h
index 55fb0e7aea78..9341821af47a 100644
--- a/MdePkg/Include/Ppi/Pcd.h
+++ b/MdePkg/Include/Ppi/Pcd.h
@@ -137,7 +137,7 @@ UINT64
 
   @param[in]  TokenNumber The PCD token number.
 
-  @return The pointer to the buffer to be retrived.
+  @return The pointer to the buffer to be retrieved.
 
 **/
 typedef
@@ -291,7 +291,7 @@ UINT64
   @param[in]  Guid        The token space for the token number.
   @param[in]  TokenNumber The PCD token number.
 
-  @return The pointer to the buffer to be retrived.
+  @return The pointer to the buffer to be retrieved.
 
 **/
 typedef
diff --git a/MdePkg/Include/Ppi/RecoveryModule.h b/MdePkg/Include/Ppi/RecoveryModule.h
index bb6b49160df6..6de937830464 100644
--- a/MdePkg/Include/Ppi/RecoveryModule.h
+++ b/MdePkg/Include/Ppi/RecoveryModule.h
@@ -36,7 +36,7 @@
 
   @par Revision Reference:
   This PPI is defined in UEFI Platform Initialization Specification 1.2 Errata B Volume 1:
-  Pre-EFI Initalization Core Interface
+  Pre-EFI Initialization Core Interface
 
 **/
 
diff --git a/MdePkg/Include/Ppi/TemporaryRamDone.h b/MdePkg/Include/Ppi/TemporaryRamDone.h
index ad149338a6ac..21c232ac9352 100644
--- a/MdePkg/Include/Ppi/TemporaryRamDone.h
+++ b/MdePkg/Include/Ppi/TemporaryRamDone.h
@@ -18,7 +18,7 @@
 
 /**
   TemporaryRamDone() disables the use of Temporary RAM. If present, this service is invoked
-  by the PEI Foundation after the EFI_PEI_PERMANANT_MEMORY_INSTALLED_PPI is installed.
+  by the PEI Foundation after the EFI_PEI_PERMANENT_MEMORY_INSTALLED_PPI is installed.
 
   @retval EFI_SUCCESS           Use of Temporary RAM was disabled.
   @retval EFI_INVALID_PARAMETER Temporary RAM could not be disabled.
diff --git a/MdePkg/Include/Ppi/VectorHandoffInfo.h b/MdePkg/Include/Ppi/VectorHandoffInfo.h
index ecfa3f5966c8..17f52ffd3d85 100644
--- a/MdePkg/Include/Ppi/VectorHandoffInfo.h
+++ b/MdePkg/Include/Ppi/VectorHandoffInfo.h
@@ -43,7 +43,7 @@ typedef struct {
   //
   UINT32    VectorNumber;
   //
-  // A bitmask that describes the attributes ofthe interrupt or exception vector.
+  // A bitmask that describes the attributes of the interrupt or exception vector.
   //
   UINT32    Attribute;
   //
-- 
2.21.0


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#52761): https://edk2.groups.io/g/devel/message/52761
Mute This Topic: https://groups.io/mt/69395729/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH v2 27/78] MdePkg/Ppi: Fix various typos
Posted by Liming Gao 6 years, 1 month ago
Reviewed-by: Liming Gao <liming.gao@intel.com>

-----Original Message-----
From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Philippe Mathieu-Daudé
Sent: 2020年1月3日 17:07
To: devel@edk2.groups.io
Cc: Antoine Coeur <coeur@gmx.fr>; Kinney, Michael D <michael.d.kinney@intel.com>; Gao, Liming <liming.gao@intel.com>; Philippe Mathieu-Daude <philmd@redhat.com>
Subject: [edk2-devel] [PATCH v2 27/78] MdePkg/Ppi: Fix various typos

From: Antoine Coeur <coeur@gmx.fr>

Fix various typos in comments and documentation.

Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
---
 MdePkg/Include/Ppi/BlockIo.h              | 4 ++--
 MdePkg/Include/Ppi/BlockIo2.h             | 2 +-
 MdePkg/Include/Ppi/Capsule.h              | 2 +-
 MdePkg/Include/Ppi/Decompress.h           | 2 +-
 MdePkg/Include/Ppi/DeviceRecoveryModule.h | 2 +-
 MdePkg/Include/Ppi/IsaHc.h                | 2 +-
 MdePkg/Include/Ppi/MpServices.h           | 2 +-
 MdePkg/Include/Ppi/Pcd.h                  | 4 ++--
 MdePkg/Include/Ppi/RecoveryModule.h       | 2 +-
 MdePkg/Include/Ppi/TemporaryRamDone.h     | 2 +-
 MdePkg/Include/Ppi/VectorHandoffInfo.h    | 2 +-
 11 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/MdePkg/Include/Ppi/BlockIo.h b/MdePkg/Include/Ppi/BlockIo.h index 524f026fe589..3a4955be6b59 100644
--- a/MdePkg/Include/Ppi/BlockIo.h
+++ b/MdePkg/Include/Ppi/BlockIo.h
@@ -15,7 +15,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 
   @par Revision Reference:
   This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 1:
-  Pre-EFI Initalization Core Interface.
+  Pre-EFI Initialization Core Interface.
 
 **/
 
@@ -58,7 +58,7 @@ typedef enum {
 /// Specification inconsistency here:
 /// PEI_BLOCK_IO_MEDIA has been changed to EFI_PEI_BLOCK_IO_MEDIA.
 /// Inconsistency exists in UEFI Platform Initialization Specification 1.2 -/// Volume 1: Pre-EFI Initalization Core Interface, where all referrences to
+/// Volume 1: Pre-EFI Initialization Core Interface, where all 
+references to
 /// this structure name are with the "EFI_" prefix, except for the definition  /// which is without "EFI_".  So the name of PEI_BLOCK_IO_MEDIA is taken as the  /// exception, and EFI_PEI_BLOCK_IO_MEDIA is used to comply with most of diff --git a/MdePkg/Include/Ppi/BlockIo2.h b/MdePkg/Include/Ppi/BlockIo2.h index e1af6a4293ed..0dba6485d941 100644
--- a/MdePkg/Include/Ppi/BlockIo2.h
+++ b/MdePkg/Include/Ppi/BlockIo2.h
@@ -7,7 +7,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 
   @par Revision Reference:
   This PPI is defined in UEFI Platform Initialization Specification 1.4 Volume 1:
-  Pre-EFI Initalization Core Interface.
+  Pre-EFI Initialization Core Interface.
 
 **/
 
diff --git a/MdePkg/Include/Ppi/Capsule.h b/MdePkg/Include/Ppi/Capsule.h index cb7b0e2ae76a..331d9b81cad2 100644
--- a/MdePkg/Include/Ppi/Capsule.h
+++ b/MdePkg/Include/Ppi/Capsule.h
@@ -45,7 +45,7 @@ typedef struct _EFI_PEI_CAPSULE_PPI PEI_CAPSULE_PPI;
                             On output, this variable will contain the size of the
                             coalesced capsule.
 
-  @retval EFI_NOT_FOUND          If: boot modecould not be determined, or the
+  @retval EFI_NOT_FOUND          If: boot mode could not be determined, or the
                                  boot mode is not flash-update, or the capsule descriptors were not found.
   @retval EFI_BUFFER_TOO_SMALL   The capsule could not be coalesced in the provided memory region.
   @retval EFI_SUCCESS            There was no capsule, or the capsule was processed successfully.
diff --git a/MdePkg/Include/Ppi/Decompress.h b/MdePkg/Include/Ppi/Decompress.h index 7ba26e419c59..b9ca63746ab2 100644
--- a/MdePkg/Include/Ppi/Decompress.h
+++ b/MdePkg/Include/Ppi/Decompress.h
@@ -1,5 +1,5 @@
 /** @file
-  Provides decompression services to the PEI Foundatoin.
+  Provides decompression services to the PEI Foundation.
 
   Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
   SPDX-License-Identifier: BSD-2-Clause-Patent diff --git a/MdePkg/Include/Ppi/DeviceRecoveryModule.h b/MdePkg/Include/Ppi/DeviceRecoveryModule.h
index a4587255a3c8..64dabec1139c 100644
--- a/MdePkg/Include/Ppi/DeviceRecoveryModule.h
+++ b/MdePkg/Include/Ppi/DeviceRecoveryModule.h
@@ -15,7 +15,7 @@
 
   @par Revision Reference:
   This PPI is defined in UEFI Platform Initialization Specification 1.2 Volume 1:
-  Pre-EFI Initalization Core Interface
+  Pre-EFI Initialization Core Interface
 
 **/
 
diff --git a/MdePkg/Include/Ppi/IsaHc.h b/MdePkg/Include/Ppi/IsaHc.h index 5468c2e94b72..d7dfd9b47e8c 100644
--- a/MdePkg/Include/Ppi/IsaHc.h
+++ b/MdePkg/Include/Ppi/IsaHc.h
@@ -28,7 +28,7 @@ typedef struct _EFI_ISA_HC_PPI *PEFI_ISA_HC_PPI;
   that more than one caller may be assigned to the same aperture.
   It may be possible that a single hardware aperture may be used for more than
   one device. This function tracks the number of times that each aperture is
-  referenced, and doesa not close the hardware aperture (via CloseIoAperture())
+  referenced, and does not close the hardware aperture (via 
+ CloseIoAperture())
   until there are no more references to it.
 
   @param This             A pointer to this instance of the EFI_ISA_HC_PPI.
diff --git a/MdePkg/Include/Ppi/MpServices.h b/MdePkg/Include/Ppi/MpServices.h index afcd8819e9cc..5ea3373909e1 100644
--- a/MdePkg/Include/Ppi/MpServices.h
+++ b/MdePkg/Include/Ppi/MpServices.h
@@ -75,7 +75,7 @@ EFI_STATUS
   );
 
 /**
-  Activate all of the application proessors.
+  Activate all of the application processors.
 
   @param[in] PeiServices          An indirect pointer to the PEI Services Table
                                   published by the PEI Foundation.
diff --git a/MdePkg/Include/Ppi/Pcd.h b/MdePkg/Include/Ppi/Pcd.h index 55fb0e7aea78..9341821af47a 100644
--- a/MdePkg/Include/Ppi/Pcd.h
+++ b/MdePkg/Include/Ppi/Pcd.h
@@ -137,7 +137,7 @@ UINT64
 
   @param[in]  TokenNumber The PCD token number.
 
-  @return The pointer to the buffer to be retrived.
+  @return The pointer to the buffer to be retrieved.
 
 **/
 typedef
@@ -291,7 +291,7 @@ UINT64
   @param[in]  Guid        The token space for the token number.
   @param[in]  TokenNumber The PCD token number.
 
-  @return The pointer to the buffer to be retrived.
+  @return The pointer to the buffer to be retrieved.
 
 **/
 typedef
diff --git a/MdePkg/Include/Ppi/RecoveryModule.h b/MdePkg/Include/Ppi/RecoveryModule.h
index bb6b49160df6..6de937830464 100644
--- a/MdePkg/Include/Ppi/RecoveryModule.h
+++ b/MdePkg/Include/Ppi/RecoveryModule.h
@@ -36,7 +36,7 @@
 
   @par Revision Reference:
   This PPI is defined in UEFI Platform Initialization Specification 1.2 Errata B Volume 1:
-  Pre-EFI Initalization Core Interface
+  Pre-EFI Initialization Core Interface
 
 **/
 
diff --git a/MdePkg/Include/Ppi/TemporaryRamDone.h b/MdePkg/Include/Ppi/TemporaryRamDone.h
index ad149338a6ac..21c232ac9352 100644
--- a/MdePkg/Include/Ppi/TemporaryRamDone.h
+++ b/MdePkg/Include/Ppi/TemporaryRamDone.h
@@ -18,7 +18,7 @@
 
 /**
   TemporaryRamDone() disables the use of Temporary RAM. If present, this service is invoked
-  by the PEI Foundation after the EFI_PEI_PERMANANT_MEMORY_INSTALLED_PPI is installed.
+  by the PEI Foundation after the EFI_PEI_PERMANENT_MEMORY_INSTALLED_PPI is installed.
 
   @retval EFI_SUCCESS           Use of Temporary RAM was disabled.
   @retval EFI_INVALID_PARAMETER Temporary RAM could not be disabled.
diff --git a/MdePkg/Include/Ppi/VectorHandoffInfo.h b/MdePkg/Include/Ppi/VectorHandoffInfo.h
index ecfa3f5966c8..17f52ffd3d85 100644
--- a/MdePkg/Include/Ppi/VectorHandoffInfo.h
+++ b/MdePkg/Include/Ppi/VectorHandoffInfo.h
@@ -43,7 +43,7 @@ typedef struct {
   //
   UINT32    VectorNumber;
   //
-  // A bitmask that describes the attributes ofthe interrupt or exception vector.
+  // A bitmask that describes the attributes of the interrupt or exception vector.
   //
   UINT32    Attribute;
   //
--
2.21.0





-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#52864): https://edk2.groups.io/g/devel/message/52864
Mute This Topic: https://groups.io/mt/69395729/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-