summaryrefslogtreecommitdiff
path: root/NetworkPkg/Dhcp4Dxe/Dhcp4Option.h
diff options
context:
space:
mode:
authorAntoine Coeur <coeur@gmx.fr>2020-02-07 02:07:44 +0100
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>2020-02-10 22:30:07 +0000
commitc194ccca2613355f0f4506e7692bc55e2eaf6ff4 (patch)
treee40937a9c2c40680c43ce8aa82d7cc5d7366a6e3 /NetworkPkg/Dhcp4Dxe/Dhcp4Option.h
parent8f628f7820f797438ca21eb6bbcef6874bea41fb (diff)
downloadedk2-c194ccca2613355f0f4506e7692bc55e2eaf6ff4.zip
edk2-c194ccca2613355f0f4506e7692bc55e2eaf6ff4.tar.gz
edk2-c194ccca2613355f0f4506e7692bc55e2eaf6ff4.tar.bz2
NetworkPkg/Dhcp4Dxe: Fix various typos
Fix various typos in comments and documentation. Cc: Jiaxin Wu <jiaxin.wu@intel.com> Cc: Siyuan Fu <siyuan.fu@intel.com> Cc: Maciej Rabeda <maciej.rabeda@intel.com> Signed-off-by: Antoine Coeur <coeur@gmx.fr> Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com> Reviewed-by: Maciej Rabeda <maciej.rabeda@intel.com> Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com> Message-Id: <20200207010831.9046-32-philmd@redhat.com>
Diffstat (limited to 'NetworkPkg/Dhcp4Dxe/Dhcp4Option.h')
-rw-r--r--NetworkPkg/Dhcp4Dxe/Dhcp4Option.h18
1 files changed, 9 insertions, 9 deletions
diff --git a/NetworkPkg/Dhcp4Dxe/Dhcp4Option.h b/NetworkPkg/Dhcp4Dxe/Dhcp4Option.h
index 393176c..a58bb1b 100644
--- a/NetworkPkg/Dhcp4Dxe/Dhcp4Option.h
+++ b/NetworkPkg/Dhcp4Dxe/Dhcp4Option.h
@@ -81,9 +81,9 @@ typedef struct {
///
/// Structure used to describe and validate the format of DHCP options.
/// Type is the options' data type, such as DHCP_OPTION_INT8. MinOccur
-/// is the minium occurance of this data type. MaxOccur is defined
+/// is the minimum occurrence of this data type. MaxOccur is defined
/// similarly. If MaxOccur is -1, it means that there is no limit on the
-/// maximum occurance. Alert tells whether DHCP client should further
+/// maximum occurrence. Alert tells whether DHCP client should further
/// inspect the option to parse DHCP_PARAMETER.
///
typedef struct {
@@ -114,8 +114,8 @@ EFI_STATUS
found
@param[in] Context The opaque parameter for Check
- @retval EFI_SUCCESS The DHCP packet's options are well formated
- @retval EFI_INVALID_PARAMETER The DHCP packet's options are not well formated
+ @retval EFI_SUCCESS The DHCP packet's options are well formatted
+ @retval EFI_INVALID_PARAMETER The DHCP packet's options are not well formatted
**/
EFI_STATUS
@@ -133,7 +133,7 @@ DhcpIterateOptions (
@param[out] Para The variable to save the DHCP parameters.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory to validate the packet.
- @retval EFI_INVALID_PARAMETER The options are malformatted
+ @retval EFI_INVALID_PARAMETER The options are mal-formatted
@retval EFI_SUCCESS The options are parsed into OptionPoint
**/
@@ -146,8 +146,8 @@ DhcpValidateOptions (
/**
Parse the options of a DHCP packet. It supports RFC 3396: Encoding
Long Options in DHCP. That is, it will combine all the option value
- of all the occurances of each option.
- A little bit of implemenation:
+ of all the occurrences of each option.
+ A little bit of implementation:
It adopts the "Key indexed counting" algorithm. First, it allocates
an array of 256 DHCP_OPTION_COUNTs because DHCP option tag is encoded
as a UINT8. It then iterates the DHCP packet to get data length of
@@ -167,7 +167,7 @@ DhcpValidateOptions (
@retval EFI_NOT_FOUND Cannot find any option.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory to parse the packet.
- @retval EFI_INVALID_PARAMETER The options are malformatted
+ @retval EFI_INVALID_PARAMETER The options are mal-formatted
@retval EFI_SUCCESS The options are parsed into OptionPoint
**/
@@ -211,7 +211,7 @@ DhcpAppendOption (
function.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory
- @retval EFI_INVALID_PARAMETER The options in SeekPacket are malformatted
+ @retval EFI_INVALID_PARAMETER The options in SeekPacket are mal-formatted
@retval EFI_SUCCESS The packet is build.
**/