Reviewed-by : Jayaprakash Nevara <n.jayaprak...@intel.com> -----Original Message----- From: R, Vishal <visha...@intel.com> Sent: Friday, November 24, 2023 4:41 PM To: devel@edk2.groups.io Cc: R, Vishal <visha...@intel.com>; Rebecca Cran <rebe...@bsdio.com>; Kinney, Michael D <michael.d.kin...@intel.com>; Jayaprakash, N <n.jayaprak...@intel.com> Subject: [edk2-libc Patch 1/1] edk2-libc/StdLib: Fixed typo issues in multiple files
REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4579 This commit fixes the various typo issues found in documentation strings in multiple files issue reported via the BZ4579 These changes are documentation updates only and does not affect the functionality of the code Cc: Rebecca Cran <rebe...@bsdio.com> Cc: Michael D Kinney <michael.d.kin...@intel.com> Cc: Jayaprakash N <n.jayaprak...@intel.com> Signed-off-by: Vishal R <visha...@intel.com> --- StdLib/BsdSocketLib/ns_addr.c | 4 ++-- StdLib/BsdSocketLib/res_comp.c | 2 +- StdLib/BsdSocketLib/res_config.h | 2 +- StdLib/BsdSocketLib/res_init.c | 2 +- StdLib/Include/arpa/telnet.h | 2 +- StdLib/Include/errno.h | 2 +- StdLib/Include/locale.h | 2 +- StdLib/Include/net/if.h | 8 ++++---- StdLib/Include/netns/ns.h | 2 +- StdLib/Include/stdio.h | 2 +- StdLib/Include/stdlib.h | 6 +++--- StdLib/Include/sys/termios.h | 14 +++++++------- StdLib/Include/sys/wait.h | 2 +- StdLib/LibC/Main/Arm/flt_rounds.c | 2 +- StdLib/LibC/StdLib/realpath.c | 2 +- StdLib/LibC/Stdio/vfscanf.c | 2 +- StdLib/LibC/Uefi/InteractiveIO/TerminalFunctions.c | 8 ++++---- StdLib/LibC/Uefi/SysCalls.c | 8 ++++---- StdLib/LibC/Wchar/String.c | 2 +- StdLib/LibC/gdtoa/gdtoaimp.h | 2 +- StdLib/PosixLib/Gen/dirname.c | 2 +- 21 files changed, 39 insertions(+), 39 deletions(-) diff --git a/StdLib/BsdSocketLib/ns_addr.c b/StdLib/BsdSocketLib/ns_addr.c index 4360b0c..36fe379 100644 --- a/StdLib/BsdSocketLib/ns_addr.c +++ b/StdLib/BsdSocketLib/ns_addr.c @@ -72,9 +72,9 @@ ns_addr( /* * First, figure out what he intends as a field separtor. - * Despite the way this routine is written, the prefered + * Despite the way this routine is written, the preferred * form 2-272.AA001234H.01777, i.e. XDE standard. - * Great efforts are made to insure backward compatability. + * Great efforts are made to insure backward compatibility. */ if ((hostname = strchr(buf, '#')) != NULL) separator = '#'; diff --git a/StdLib/BsdSocketLib/res_comp.c b/StdLib/BsdSocketLib/res_comp.c index 7c327fa..8e52e32 100644 --- a/StdLib/BsdSocketLib/res_comp.c +++ b/StdLib/BsdSocketLib/res_comp.c @@ -108,7 +108,7 @@ static char rcsid[] = "$Id: res_comp.c,v 1.1.1.1 2003/11/19 01:51:35 kyu3 Exp $" /* * Expand compressed domain name 'comp_dn' to full domain name. - * 'msg' is a pointer to the begining of the message, + * 'msg' is a pointer to the beginning of the message, * 'eomorig' points to the first location after the message, * 'exp_dn' is a pointer to a buffer of size 'length' for the result. * Return size of compressed name or -1 if there was an error. diff --git a/StdLib/BsdSocketLib/res_config.h b/StdLib/BsdSocketLib/res_config.h index 4f4afdf..e3128e1 100644 --- a/StdLib/BsdSocketLib/res_config.h +++ b/StdLib/BsdSocketLib/res_config.h @@ -1,6 +1,6 @@ #define DEBUG 1 /* enable debugging code (needed for dig) */ #define RESOLVSORT /* allow sorting of addresses in gethostbyname */ -#define RFC1535 /* comply with RFC1535 (STRONGLY reccomended by vixie)*/ +#define RFC1535 /* comply with RFC1535 (STRONGLY recommended by vixie)*/ #undef USELOOPBACK /* res_init() bind to localhost */ #undef SUNSECURITY /* verify gethostbyaddr() calls - WE DONT NEED IT */ #define MULTI_PTRS_ARE_ALIASES 1 /* fold multiple PTR records into aliases */ diff --git a/StdLib/BsdSocketLib/res_init.c b/StdLib/BsdSocketLib/res_init.c index 9df7d4f..449cb17 100644 --- a/StdLib/BsdSocketLib/res_init.c +++ b/StdLib/BsdSocketLib/res_init.c @@ -134,7 +134,7 @@ struct __res_state _res * there will have precedence. Otherwise, the server address is set to * INADDR_ANY and the default domain name comes from the gethostname(). * - * An interrim version of this code (BIND 4.9, pre-4.4BSD) used 127.0.0.1 + * An interim version of this code (BIND 4.9, pre-4.4BSD) used + 127.0.0.1 * rather than INADDR_ANY ("0.0.0.0") as the default name server address * since it was noted that INADDR_ANY actually meant ``the first interface * you "ifconfig"'d at boot time'' and if this was a SLIP or PPP interface, diff --git a/StdLib/Include/arpa/telnet.h b/StdLib/Include/arpa/telnet.h index d7c8ecb..04c4a30 100644 --- a/StdLib/Include/arpa/telnet.h +++ b/StdLib/Include/arpa/telnet.h @@ -213,7 +213,7 @@ char *telopts[NTELOPTS+1] = { #define NSLC 30 /* - * For backwards compatability, we define SLC_NAMES to be the + * For backwards compatibility, we define SLC_NAMES to be the * list of names if SLC_NAMES is not defined. */ #define SLC_NAMELIST "0", "SYNCH", "BRK", "IP", "AO", "AYT", "EOR", \ diff --git a/StdLib/Include/errno.h b/StdLib/Include/errno.h index a819d08..e24547f 100644 --- a/StdLib/Include/errno.h +++ b/StdLib/Include/errno.h @@ -18,7 +18,7 @@ of errno is not documented in the description of the function in the governing standard: ISO/IEC 9899:1990 with Amendment 1 or ISO/IEC 9899:199409. - EFIerrno, like errno, should only be checked if it is known that the preceeding function call + EFIerrno, like errno, should only be checked if it is known that the + preceding function call called a UEFI function. Functions in which UEFI functions are called dependent upon context or parameter values should guarantee that EFIerrno is set to zero by default, or to the status value returned by any UEFI functions which are called. diff --git a/StdLib/Include/locale.h b/StdLib/Include/locale.h index 93aac0a..169e65d 100644 --- a/StdLib/Include/locale.h +++ b/StdLib/Include/locale.h @@ -93,7 +93,7 @@ struct lconv { the international currency symbol from the monetary quantity. */ char *currency_symbol; /**< "" The local currency symbol for the current locale. */ char *mon_decimal_point; /**< "" The decimal point used for monetary values. */ - char *mon_thousands_sep; /**< "" The separator for digit groups preceeding the decimal-point. */ + char *mon_thousands_sep; /**< "" The separator for digit groups preceding the decimal-point. */ char *mon_grouping; /**< "" A string, like grouping, for monetary values. */ char *positive_sign; /**< "" A string to indicate a non-negative monetary value. */ char *negative_sign; /**< "" A string to indicate a negative monetary value. */ diff --git a/StdLib/Include/net/if.h b/StdLib/Include/net/if.h index 0b8afa0..3c61184 100644 --- a/StdLib/Include/net/if.h +++ b/StdLib/Include/net/if.h @@ -39,7 +39,7 @@ /* * <net/if.h> does not depend on <sys/time.h> on most other systems. This - * helps userland compatability. (struct timeval ifi_lastchange) + * helps userland compatibility. (struct timeval ifi_lastchange) */ #ifndef KERNEL #include <sys/time.h> @@ -109,7 +109,7 @@ struct if_data { */ struct if_msghdr { u_short ifm_msglen; /* to skip over non-understood messages */ - u_char ifm_version; /* future binary compatability */ + u_char ifm_version; /* future binary compatibility */ u_char ifm_type; /* message type */ int ifm_addrs; /* like rtm_addrs */ int ifm_flags; /* value of if_flags */ @@ -123,7 +123,7 @@ struct if_msghdr { */ struct ifa_msghdr { u_short ifam_msglen; /* to skip over non-understood messages */ - u_char ifam_version; /* future binary compatability */ + u_char ifam_version; /* future binary compatibility */ u_char ifam_type; /* message type */ int ifam_addrs; /* like rtm_addrs */ int ifam_flags; /* value of ifa_flags */ @@ -137,7 +137,7 @@ struct ifa_msghdr { */ struct ifma_msghdr { u_short ifmam_msglen; /* to skip over non-understood messages */ - u_char ifmam_version; /* future binary compatability */ + u_char ifmam_version; /* future binary compatibility */ u_char ifmam_type; /* message type */ int ifmam_addrs; /* like rtm_addrs */ int ifmam_flags; /* value of ifa_flags */ diff --git a/StdLib/Include/netns/ns.h b/StdLib/Include/netns/ns.h index 58bac08..5577862 100644 --- a/StdLib/Include/netns/ns.h +++ b/StdLib/Include/netns/ns.h @@ -63,7 +63,7 @@ #define NSPORT_RE 3 /* Router Error */ /* - * Ports < NSPORT_RESERVED are reserved for priveleged + * Ports < NSPORT_RESERVED are reserved for privileged * processes (e.g. root). */ #define NSPORT_RESERVED 3000 diff --git a/StdLib/Include/stdio.h b/StdLib/Include/stdio.h index c0a4deb..b4db3b0 100644 --- a/StdLib/Include/stdio.h +++ b/StdLib/Include/stdio.h @@ -353,7 +353,7 @@ int rename (const char *OldName, const char *NewName); /** Create a guaranteed unique temporary file. A binary file is created in the _PATH_TMP directory that is guaranteed to have a unique name. The file will be open for update with mode "wb+" and - its FILE pointer returned upon successfull completion. When the file is + its FILE pointer returned upon successful completion. When the + file is closed, or when the creating program terminates, the file will be removed. @retval NULL The temporary file could not be created. diff --git a/StdLib/Include/stdlib.h b/StdLib/Include/stdlib.h index 022ddbd..d9aaaab 100644 --- a/StdLib/Include/stdlib.h +++ b/StdLib/Include/stdlib.h @@ -73,7 +73,7 @@ size_t wcstombs (char * __restrict dest, const wchar_t * __restrict src, size_t limit); - ################ Miscelaneous functions for *nix compatibility + ################ Miscellaneous functions for *nix compatibility char *realpath (const char *file_name, char *resolved_name); const char *getprogname (void); void setprogname (const char *progname); @@ -858,7 +858,7 @@ size_t mbstowcs(wchar_t * __restrict Dest, const char * __restrict Src, size_t **/ size_t wcstombs(char * __restrict Dest, const wchar_t * __restrict Src, size_t Limit); -/* ############## Miscelaneous functions for *nix compatibility ########## */ +/* ############## Miscellaneous functions for *nix compatibility +########## */ /** The realpath() function shall derive, from the pathname pointed to by file_name, an absolute pathname that names the same file, whose resolution @@ -872,7 +872,7 @@ size_t wcstombs(char * __restrict Dest, const wchar_t * __restrict Src, size_t @param[in] file_name The filename to convert. @param[in,out] resolved_name The resultant name. - @retval NULL An error occured. + @retval NULL An error occurred. @retval resolved_name. **/ char * realpath(const char *file_name, char *resolved_name); diff --git a/StdLib/Include/sys/termios.h b/StdLib/Include/sys/termios.h index f2d60d0..1cf5e58 100644 --- a/StdLib/Include/sys/termios.h +++ b/StdLib/Include/sys/termios.h @@ -253,7 +253,7 @@ speed_t cfgetospeed (const struct termios *); @param[in] NewSpeed The new input baud rate. @retval 0 The operation completed successfully. - @retval -1 An error occured and errno is set to indicate the error. + @retval -1 An error occurred and errno is set to indicate the error. * EINVAL - The value of NewSpeed is outside the range of possible speed values as specified in <sys/termios.h>. **/ @@ -269,7 +269,7 @@ int cfsetispeed (struct termios *, speed_t); @param[in] NewSpeed The new output baud rate. @retval 0 The operation completed successfully. - @retval -1 An error occured and errno is set to indicate the error. + @retval -1 An error occurred and errno is set to indicate the error. * EINVAL - The value of NewSpeed is outside the range of possible speed values as specified in <sys/termios.h>. **/ @@ -285,7 +285,7 @@ int cfsetospeed (struct termios *, speed_t); attributes of the interactive IO device. @retval 0 The operation completed successfully. - @retval -1 An error occured and errno is set to indicate the error. + @retval -1 An error occurred and errno is set to indicate the error. * EBADF - The fd argument is not a valid file descriptor. * ENOTTY - The file associated with fd is not an interactive IO device. **/ @@ -311,7 +311,7 @@ int tcgetattr (int fd, struct termios *pTermios); attributes to set in the interactive IO device. @retval 0 The operation completed successfully. - @retval -1 An error occured and errno is set to indicate the error. + @retval -1 An error occurred and errno is set to indicate the error. * EBADF - The fd argument is not a valid file descriptor. * ENOTTY - The file associated with fd is not an interactive IO device. **/ @@ -323,7 +323,7 @@ int tcsetattr (int fd, int OptAct, const struct termios *pTermios); @param[in] fd The file descriptor for an open interactive IO device. @retval 0 The operation completed successfully. - @retval -1 An error occured and errno is set to indicate the error. + @retval -1 An error occurred and errno is set to indicate the error. * EBADF - The fd argument is not a valid file descriptor. * ENOTTY - The file associated with fd is not an interactive IO device. * EINTR - A signal interrupted tcdrain(). @@ -348,7 +348,7 @@ int tcdrain (int fd); terminal device to start transmitting data. @retval 0 The operation completed successfully. - @retval -1 An error occured and errno is set to indicate the error. + @retval -1 An error occurred and errno is set to indicate the error. * EBADF - The fd argument is not a valid file descriptor. * ENOTTY - The file associated with fd is not an interactive IO device. * EINVAL - The Action argument is not a supported value. @@ -370,7 +370,7 @@ int tcflow (int fd, int Action); Otherwise error EINVAL. @retval 0 The operation completed successfully. - @retval -1 An error occured and errno is set to indicate the error. + @retval -1 An error occurred and errno is set to indicate the error. * EBADF - The fd argument is not a valid file descriptor. * ENOTTY - The file associated with fd is not an interactive IO device. * EINVAL - The QueueSelector argument is not a supported value. diff --git a/StdLib/Include/sys/wait.h b/StdLib/Include/sys/wait.h index 64200aa..b188107 100644 --- a/StdLib/Include/sys/wait.h +++ b/StdLib/Include/sys/wait.h @@ -37,7 +37,7 @@ #include <sys/types.h> /* - * This file holds definitions relevent to the wait4 system call + * This file holds definitions relevant to the wait4 system call * and the alternate interfaces that use it (wait, wait3, waitpid). */ diff --git a/StdLib/LibC/Main/Arm/flt_rounds.c b/StdLib/LibC/Main/Arm/flt_rounds.c index 7e052cc..e3b595e 100644 --- a/StdLib/LibC/Main/Arm/flt_rounds.c +++ b/StdLib/LibC/Main/Arm/flt_rounds.c @@ -52,7 +52,7 @@ static const int map[] = { * Returns: * 0 - round to zero * 1 - round to nearest - * 2 - round to postive infinity + * 2 - round to positive infinity * 3 - round to negative infinity * * ok all we need to do is get the current FP rounding mode diff --git a/StdLib/LibC/StdLib/realpath.c b/StdLib/LibC/StdLib/realpath.c index 29abe9a..a528f13 100644 --- a/StdLib/LibC/StdLib/realpath.c +++ b/StdLib/LibC/StdLib/realpath.c @@ -29,7 +29,7 @@ @param[in] file_name The filename to convert. @param[in,out] resolved_name The resultant name. - @retval NULL An error occured. + @retval NULL An error occurred. @return resolved_name. **/ char * diff --git a/StdLib/LibC/Stdio/vfscanf.c b/StdLib/LibC/Stdio/vfscanf.c index 1e8c7f9..692d55a 100644 --- a/StdLib/LibC/Stdio/vfscanf.c +++ b/StdLib/LibC/Stdio/vfscanf.c @@ -927,7 +927,7 @@ doswitch: * z', but treats `a-a' as `the letter a, the * character -, and the letter a'. * - * For compatibility, the `-' is not considerd + * For compatibility, the `-' is not considered * to define a range if the character following * it is either a close bracket (required by ANSI) * or is not numerically greater than the character diff --git a/StdLib/LibC/Uefi/InteractiveIO/TerminalFunctions.c b/StdLib/LibC/Uefi/InteractiveIO/TerminalFunctions.c index 807ab1f..d6d95e8 100644 --- a/StdLib/LibC/Uefi/InteractiveIO/TerminalFunctions.c +++ b/StdLib/LibC/Uefi/InteractiveIO/TerminalFunctions.c @@ -68,7 +68,7 @@ cfgetospeed ( @param[in] NewSpeed The new input baud rate. @retval 0 The operation completed successfully. - @retval -1 An error occured and errno is set to indicate the error. + @retval -1 An error occurred and errno is set to indicate the error. * EINVAL - The value of NewSpeed is outside the range of possible speed values as specified in <sys/termios.h>. **/ @@ -101,7 +101,7 @@ cfsetispeed ( @param[in] NewSpeed The new output baud rate. @retval 0 The operation completed successfully. - @retval -1 An error occured and errno is set to indicate the error. + @retval -1 An error occurred and errno is set to indicate the error. * EINVAL - The value of NewSpeed is outside the range of possible speed values as specified in <sys/termios.h>. **/ @@ -134,7 +134,7 @@ cfsetospeed ( attributes of the interactive IO device. @retval 0 The operation completed successfully. - @retval -1 An error occured and errno is set to indicate the error. + @retval -1 An error occurred and errno is set to indicate the error. * EBADF - The fd argument is not a valid file descriptor. * ENOTTY - The file associated with fd is not an interactive IO device. **/ @@ -191,7 +191,7 @@ tcgetattr ( attributes to set in the interactive IO device. @retval 0 The operation completed successfully. - @retval -1 An error occured and errno is set to indicate the error. + @retval -1 An error occurred and errno is set to indicate the error. * EBADF - The fd argument is not a valid file descriptor. * ENOTTY - The file associated with fd is not an interactive IO device. **/ diff --git a/StdLib/LibC/Uefi/SysCalls.c b/StdLib/LibC/Uefi/SysCalls.c index 0c8dcc1..23b5984 100644 --- a/StdLib/LibC/Uefi/SysCalls.c +++ b/StdLib/LibC/Uefi/SysCalls.c @@ -910,7 +910,7 @@ poll ( @param[in] To The new name of From. @retval 0 Successful completion. - @retval -1 An error has occured and errno has been set to further specify the error. + @retval -1 An error has occurred and errno has been set to further specify the error. Neither the file named by From nor the file named by To are changed or created. - ENXIO: Path specified is not supported by any loaded driver. @@ -951,7 +951,7 @@ rename( @param[in] path Path to the directory to delete. @retval -1 The directory couldn't be opened (doesn't exist). - @retval -1 The directory wasn't empty or an IO error occured. + @retval -1 The directory wasn't empty or an IO error occurred. **/ int rmdir( @@ -1072,7 +1072,7 @@ lstat (const char *path, struct stat *statbuf) @param[in,out] ... Zero or more parameters as required for request. @retval >=0 The operation completed successfully. - @retval -1 An error occured. More information is in errno. + @retval -1 An error occurred. More information is in errno. **/ int ioctl( @@ -1441,7 +1441,7 @@ va_Utimes( @param[in] times Pointer to an array of two timeval structures @retval 0 File times successfully set. - @retval -1 An error occured. Error type in errno. + @retval -1 An error occurred. Error type in errno. **/ int utimes( diff --git a/StdLib/LibC/Wchar/String.c b/StdLib/LibC/Wchar/String.c index 70f6d9a..8ccbcfd 100644 --- a/StdLib/LibC/Wchar/String.c +++ b/StdLib/LibC/Wchar/String.c @@ -1,5 +1,5 @@ /** @file - Miscelaneous Functions for <wchar.h>. + Miscellaneous Functions for <wchar.h>. Unless explicitly stated otherwise, if the execution of a function declared in this file causes copying to take place between objects that overlap, the diff --git a/StdLib/LibC/gdtoa/gdtoaimp.h b/StdLib/LibC/gdtoa/gdtoaimp.h index a5eaa72..601c908 100644 --- a/StdLib/LibC/gdtoa/gdtoaimp.h +++ b/StdLib/LibC/gdtoa/gdtoaimp.h @@ -1,5 +1,5 @@ /** @file - This is a variation on dtoa.c that converts arbitary binary + This is a variation on dtoa.c that converts arbitrary binary floating-point formats to and from decimal notation. It uses double-precision arithmetic internally, so there are still various #ifdefs that adapt the calculations to the native diff --git a/StdLib/PosixLib/Gen/dirname.c b/StdLib/PosixLib/Gen/dirname.c index eb924d4..53f253f 100644 --- a/StdLib/PosixLib/Gen/dirname.c +++ b/StdLib/PosixLib/Gen/dirname.c @@ -70,7 +70,7 @@ dirname(char *path) while (lastp != path && isDirSep(*lastp)) lastp--; - /* Terminate path at the last occurence of '/'. */ + /* Terminate path at the last occurrence of '/'. */ do { if (isDirSep(*lastp)) { /* Strip trailing slashes, if any. */ -- 2.39.1.windows.1 -=-=-=-=-=-=-=-=-=-=-=- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#111701): https://edk2.groups.io/g/devel/message/111701 Mute This Topic: https://groups.io/mt/102779152/21656 Group Owner: devel+ow...@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
