On Fri, 3 Jan 2020 at 10:08, Philippe Mathieu-Daude <phi...@redhat.com> wrote:
>
> From: Antoine Coeur <co...@gmx.fr>
>
> Fix few typos in the documentation.
>
> Cc: Leif Lindholm <leif.lindh...@linaro.org>
> Cc: Ard Biesheuvel <ard.biesheu...@linaro.org>
> Signed-off-by: Antoine Coeur <co...@gmx.fr>
> Reviewed-by: Philippe Mathieu-Daude <phi...@redhat.com>
> Signed-off-by: Philippe Mathieu-Daude <phi...@redhat.com>

Reviewed-by: Ard Biesheuvel <ard.biesheu...@linaro.org>

Nit below

> ---
>  .../Drivers/VirtualKeyboardDxe/VirtualKeyboard.h | 14 +++++++-------
>  .../Drivers/VirtualKeyboardDxe/VirtualKeyboard.c | 16 ++++++++--------
>  2 files changed, 15 insertions(+), 15 deletions(-)
>
> diff --git a/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h 
> b/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h
> index 29bc7a06fb16..026449046653 100644
> --- a/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h
> +++ b/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h
> @@ -323,7 +323,7 @@ VirtualKeyboardReset (
>    );
>
>  /**
> -  Reset the input device and optionaly run diagnostics
> +  Reset the input device and optionally run diagnostics
>
>    @param  This                  Protocol instance pointer.
>    @param  ExtendedVerification  Driver may perform diagnostics on reset.
> @@ -373,7 +373,7 @@ VirtualKeyboardSetState (
>
>
>    @retval EFI_SUCCESS             The notification function was registered 
> successfully.
> -  @retval EFI_OUT_OF_RESOURCES    Unable to allocate resources for 
> necesssary data structures.
> +  @retval EFI_OUT_OF_RESOURCES    Unable to allocate resources for necessary 
> data structures.
>    @retval EFI_INVALID_PARAMETER   KeyData or NotifyHandle is NULL.
>
>  **/
> @@ -429,7 +429,7 @@ VirtualKeyboardFreeNotifyList (
>                              state data for the key that was pressed.
>
>    @retval TRUE              Key be pressed matches a registered key.
> -  @retval FLASE             Match failed.
> +  @retval FALSE             Match failed.
>
>  **/
>  BOOLEAN
> @@ -441,7 +441,7 @@ IsKeyRegistered (
>  /**
>    Waiting on the keyboard event, if there's any key pressed by the user, 
> signal the event
>
> -  @param  Event       The event that be siganlled when any key has been 
> stroked.
> +  @param  Event       The event that be signalled when any key has been 
> stroked.

stroked -> struck?

>    @param  Context     Pointer of the protocol EFI_SIMPLE_TEXT_INPUT_PROTOCOL.
>
>  **/
> @@ -455,7 +455,7 @@ VirtualKeyboardWaitForKey (
>  /**
>    Waiting on the keyboard event, if there's any key pressed by the user, 
> signal the event
>
> -  @param  Event    The event that be siganlled when any key has been stroked.
> +  @param  Event    The event that be signalled when any key has been stroked.
>    @param  Context  Pointer of the protocol EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.
>
>  **/
> @@ -514,14 +514,14 @@ VirtualKeyboardReadKeyStroke (
>
>  /**
>    Reads the next keystroke from the input device. The WaitForKey Event can
> -  be used to test for existance of a keystroke via WaitForEvent () call.
> +  be used to test for existence of a keystroke via WaitForEvent () call.
>
>    @param  This         Protocol instance pointer.
>    @param  KeyData      A pointer to a buffer that is filled in with the 
> keystroke
>                         state data for the key that was pressed.
>
>    @retval  EFI_SUCCESS           The keystroke information was returned.
> -  @retval  EFI_NOT_READY         There was no keystroke data availiable.
> +  @retval  EFI_NOT_READY         There was no keystroke data available.
>    @retval  EFI_DEVICE_ERROR      The keystroke information was not returned 
> due to
>                                   hardware errors.
>    @retval  EFI_INVALID_PARAMETER KeyData is NULL.
> diff --git a/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c 
> b/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c
> index 750371a06723..e9d0b72ee6c3 100644
> --- a/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c
> +++ b/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c
> @@ -437,7 +437,7 @@ VirtualKeyboardFreeNotifyList (
>                                pressed.
>
>    @retval TRUE                Key be pressed matches a registered key.
> -  @retval FLASE               Match failed.
> +  @retval FALSE               Match failed.
>
>  **/
>  BOOLEAN
> @@ -476,7 +476,7 @@ IsKeyRegistered (
>    Signal the event if there is key available
>
>    @param Event    the event object
> -  @param Context  waitting context
> +  @param Context  waiting context
>
>  **/
>  VOID
> @@ -580,7 +580,7 @@ VirtualKeyboardReset (
>  }
>
>  /**
> -  Reset the input device and optionaly run diagnostics
> +  Reset the input device and optionally run diagnostics
>
>    @param  This                  Protocol instance pointer.
>    @param  ExtendedVerification  Driver may perform diagnostics on reset.
> @@ -621,7 +621,7 @@ VirtualKeyboardResetEx (
>
>  /**
>    Reads the next keystroke from the input device. The WaitForKey Event can
> -  be used to test for existance of a keystroke via WaitForEvent () call.
> +  be used to test for existence of a keystroke via WaitForEvent () call.
>
>    @param  VirtualKeyboardPrivate   Virtualkeyboard driver private structure.
>    @param  KeyData                  A pointer to a buffer that is filled in
> @@ -629,7 +629,7 @@ VirtualKeyboardResetEx (
>                                     that was pressed.
>
>    @retval EFI_SUCCESS              The keystroke information was returned.
> -  @retval EFI_NOT_READY            There was no keystroke data availiable.
> +  @retval EFI_NOT_READY            There was no keystroke data available.
>    @retval EFI_DEVICE_ERROR         The keystroke information was not returned
>                                     due to hardware errors.
>    @retval EFI_INVALID_PARAMETER    KeyData is NULL.
> @@ -731,14 +731,14 @@ VirtualKeyboardReadKeyStroke (
>
>  /**
>    Reads the next keystroke from the input device. The WaitForKey Event can
> -  be used to test for existance of a keystroke via WaitForEvent () call.
> +  be used to test for existence of a keystroke via WaitForEvent () call.
>
>    @param  This         Protocol instance pointer.
>    @param  KeyData      A pointer to a buffer that is filled in with the
>                         keystroke state data for the key that was pressed.
>
>    @retval  EFI_SUCCESS           The keystroke information was returned.
> -  @retval  EFI_NOT_READY         There was no keystroke data availiable.
> +  @retval  EFI_NOT_READY         There was no keystroke data available.
>    @retval  EFI_DEVICE_ERROR      The keystroke information was not returned
>                                   due to hardware errors.
>    @retval  EFI_INVALID_PARAMETER KeyData is NULL.
> @@ -808,7 +808,7 @@ VirtualKeyboardSetState (
>
>    @retval EFI_SUCCESS             The notification function was registered
>                                    successfully.
> -  @retval EFI_OUT_OF_RESOURCES    Unable to allocate resources for necesssary
> +  @retval EFI_OUT_OF_RESOURCES    Unable to allocate resources for necessary
>                                    data structures.
>    @retval EFI_INVALID_PARAMETER   KeyData or NotifyHandle is NULL.
>
> --
> 2.21.0
>

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

View/Reply Online (#53015): https://edk2.groups.io/g/devel/message/53015
Mute This Topic: https://groups.io/mt/69395702/21656
Group Owner: devel+ow...@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [arch...@mail-archive.com]
-=-=-=-=-=-=-=-=-=-=-=-

Reply via email to