diff --git a/CMakeLists.txt b/CMakeLists.txt index 519183d1e..3dbc9ef66 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -48,7 +48,7 @@ project(OSAL C) # part of the open source release. # CAUTION: The API between the OSAL and the low level implementation and/or BSP # is not stabilized, and may change with every OSAL release. No attempt is made -# to provide backward compatibility with to external sources. +# to provide backward compatibility with external sources. set(OSAL_EXT_SOURCE_DIR "$ENV{OSAL_EXT_SOURCE_DIR}" CACHE PATH "External source directory to check for additional OS/BSP implementations") @@ -106,7 +106,7 @@ add_subdirectory(ut_assert) # OSAL_SYSTEM_BSPTYPE indicate which of the BSP packages -# to build. These is required and must be defined. Confirm that this exists +# to build. This is required and must be defined. Confirm that this exists # and error out now if it does not. if (NOT DEFINED OSAL_SYSTEM_BSPTYPE) message(FATAL_ERROR "OSAL_SYSTEM_BSPTYPE must be set to the appropriate BSP") diff --git a/Makefile.sample b/Makefile.sample index a49cd2093..d3f83f835 100644 --- a/Makefile.sample +++ b/Makefile.sample @@ -83,13 +83,13 @@ $(FILETGTS): $(MAKE) -C $(O) $(@) endif -# The "prep" step requires extra options that are specified via enviroment variables. +# The "prep" step requires extra options that are specified via environment variables. # Certain special ones should be passed via cache (-D) options to CMake. # These are only needed for the "prep" target but they are computed globally anyway. # -# Note this simple makefile just builds for one target, could trivally manage +# Note this simple makefile just builds for one target, could trivially manage # multiple targets by changing build directory. More complex target -# list examples are provide by cFE.. +# list examples are provided by cFE. PREP_OPTS := -DOSAL_SYSTEM_BSPTYPE=$(BSPTYPE) -DINSTALL_TARGET_LIST=. ifneq ($(INSTALLPREFIX),) diff --git a/README.md b/README.md index d0986500c..3ca65635a 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This repository contains NASA's Operating System Abstraction Layer (OSAL), which is a framework component of the Core Flight System. -This is a collection of abstractio APIs and associated framework to be located in the `osal` subdirectory of a cFS Mission Tree. The Core Flight System is bundled at , which includes build and execution instructions. +This is a collection of abstraction APIs and associated framework to be located in the `osal` subdirectory of a cFS Mission Tree. The Core Flight System is bundled at , which includes build and execution instructions. The autogenerated OSAL user's guide can be viewed at . @@ -134,14 +134,14 @@ See and and ### Development Build: v5.1.0-rc1+dev411 -- [docs] Clarifies that that zero will be returned on EOF condition in the API documentation for OS_read/write/TimedRead/TimedWrite. In the case of the timed API calls, the `OS_ERR_TIMEOUT` status code will be returned if the timeout expired without the handle becoming readable/writable during that time. -- Addresses a shortcomings in the UT Assert hook functions. Namely the assumed return type of int32 which is not always the case. +- [docs] Clarifies that zero will be returned on EOF condition in the API documentation for OS_read/write/TimedRead/TimedWrite. In the case of the timed API calls, the `OS_ERR_TIMEOUT` status code will be returned if the timeout expired without the handle becoming readable/writable during that time. +- Addresses shortcomings in the UT Assert hook functions. Namely the assumed return type of int32 which is not always the case. - Adds the concept of a "handler" function to UT assert to replace hard-coded custom logic in UT assert. A handler is the custom logic that exists between the hook function and the return to the stub caller. The handler is directly responsible for setting all outputs. - Adds a script to auto-generate stub functions that match this pattern. Given an API header file, the script extracts the declarations, and generates a source file with stub definitions that rely on a separate handler to deal with the needed outputs. @@ -156,7 +156,7 @@ the declarations, and generates a source file with stub definitions that rely on ### Development Build: v5.1.0-rc1+dev393 - Changes parameter names to avoid collisions. Renames `access` as `access_mode` in `osapi-file.h`. Renames `time` as `TimeSp` in `os-impl-posix-gettime.c`. -- Deletes the broken RTEMS `os-impl-shell.c` file so so OSAL builds with `OSAL_CONFIG_INCLUDE_SHELL=true`. RTEMS will always report `OS_ERR_NOT_IMPLEMENTED`. +- Deletes the broken RTEMS `os-impl-shell.c` file so OSAL builds with `OSAL_CONFIG_INCLUDE_SHELL=true`. RTEMS will always report `OS_ERR_NOT_IMPLEMENTED`. - See and ### Development Build: v5.1.0-rc1+dev387 @@ -172,7 +172,7 @@ the declarations, and generates a source file with stub definitions that rely on ### Development Build: v5.1.0-rc1+dev378 - Replaces nonstandard header file block comments and include guards. No behavior changes -- Removes `CLOCK_MONOTONIC` as the osal colck source since PSP no longer needs it. `OS_GetLocalTime()` and `OS_SetLocalTime()` will work as described. +- Removes `CLOCK_MONOTONIC` as the osal clock source since PSP no longer needs it. `OS_GetLocalTime()` and `OS_SetLocalTime()` will work as described. - Replaces `shellName` with a specific `localShellName` that can be polled safely and changes its type to a char of `OS_MAX_API_NAME` length for safety. - See and @@ -182,7 +182,7 @@ the declarations, and generates a source file with stub definitions that rely on - Applies minor code and documentation cleanup: white space, typos, etc. - Adds test to get full coverage of vxworks in `os-impl-bsd-socket.c` resulting in full line coverage for OSAL - Adds more descriptive return codes if `OS_SymbolTableDump_Impl` does not do what is expected. Adds a new error `OS_ERR_OUTPUT_TOO_LARGE` if the size limit was insufficient. Return `OS_ERROR` if an empty file was written - this likely indicates some fundamental issue with the VxWorks symbol table. Returns `OS_ERR_NAME_TOO_LONG` if one of the symbol names was too long. Improves unit test to check for/verify these responses. -- Removes the unneeded `OS_TaskRegister()` and all references to it in code, tests, and documentation. No impact to behavior, but does affect API and has depenedencies +- Removes the unneeded `OS_TaskRegister()` and all references to it in code, tests, and documentation. No impact to behavior, but does affect API and has dependencies - Removes unused `-SCRIPT_MODE` flag in cmake - Remove comparison between `osal_id_t` and `integers` to use the provided comparison function, `OS_ObjectIdDefined()`. System builds and runs again when using a type-safe/non-integer osal_id_t type. - See @@ -379,7 +379,7 @@ OS_MutSemTake():216:WARNING: Task 65547 taking mutex 327685 while owned by task ### Development Build: v5.1.0-rc1+dev60 -- Appliy standard formating, whitespace-only changes +- Apply standard formatting, whitespace-only changes - See ### Development Build: v5.1.0-rc1+dev55 @@ -407,7 +407,7 @@ OS_MutSemTake():216:WARNING: Task 65547 taking mutex 327685 while owned by task ### Development Build: v5.1.0-rc1+dev34 -- Move this existing function into the public API, as it is performs more verification than the OS_ConvertToArrayIndex function. +- Move this existing function into the public API, as it performs more verification than the OS_ConvertToArrayIndex function. - The C library type is signed, and this makes the result check work as intended. - See @@ -453,7 +453,7 @@ a common location for additional table-deletion-related logic. - No impact to current unit testing which runs UT assert as a standalone app. Add a position independent code (PIC) variant of the ut_assert library, which can be dynamically loaded into other applications rather than running as a standalone OSAL application. This enables loading UT assert as a CFE library. - Unit tests pass on RTEMS. -- Resolve inconsistency in how the stack size is treated across different OS implemntations. With this change the user-requested size is passed through to the underlying OS without an enforced minimum. An additional sanity check is added at the shared layer to ensure that the stack size is never passed as 0. +- Resolve inconsistency in how the stack size is treated across different OS implementations. With this change the user-requested size is passed through to the underlying OS without an enforced minimum. An additional sanity check is added at the shared layer to ensure that the stack size is never passed as 0. - Update Licenses for Apache 2.0 - See diff --git a/SECURITY.md b/SECURITY.md index c53d27f70..15371021a 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -6,7 +6,7 @@ To report a vulnerability for the OSAL subsystem please [submit an issue](https: For general cFS vulnerabilities please [open a cFS framework issue](https://github.com/nasa/cfs/issues/new/choose) and see our [top-level security policy](https://github.com/nasa/cFS/security/policy) for additional information. -In either case please use the "Bug Report" template and provide as much information as possible. Apply appropraite labels for each report. For security related reports, tag the issue with the "security" label. +In either case please use the "Bug Report" template and provide as much information as possible. Apply appropriate labels for each report. For security related reports, tag the issue with the "security" label. ## Testing diff --git a/default_config.cmake b/default_config.cmake index 2ba2c0d1d..62172307c 100644 --- a/default_config.cmake +++ b/default_config.cmake @@ -30,7 +30,7 @@ # either in the OSAL or the application which invoked OSAL. # # If set FALSE (default), then the OSAL bugcheck macro will evaluate its -# boolean conditional and generate an action if that conditional evaulates +# boolean conditional and generate an action if that conditional evaluates # false. (The specific action to take is configured via a different # directive -- see OSAL_CONFIG_BUGCHECK_STRICT). # @@ -73,7 +73,7 @@ set(OSAL_CONFIG_BUGCHECK_STRICT FALSE) # # Whether to include the Network API # -# If set TRUE, the the socket abstraction (if applicable on the platform) +# If set TRUE, the socket abstraction (if applicable on the platform) # will be included. If set FALSE, then all calls to the network API will # return OS_ERR_NOT_IMPLEMENTED. # @@ -276,12 +276,12 @@ set(OSAL_CONFIG_MAX_FILE_NAME 20 CACHE STRING "Maximum Length of file names" ) -# Maximum length for an virtual path name (virtual directory + file) +# Maximum length for a virtual path name (virtual directory + file) set(OSAL_CONFIG_MAX_PATH_LEN 64 CACHE STRING "Maximum Length of path names" ) -# Maximum length allowed for a object (task,queue....) name +# Maximum length allowed for an object (task,queue....) name set(OSAL_CONFIG_MAX_API_NAME 20 CACHE STRING "Maximum Length of resource names" ) diff --git a/docs/OSAL-Configuration-Guide.md b/docs/OSAL-Configuration-Guide.md index 710aed2f5..a2c4660a4 100644 --- a/docs/OSAL-Configuration-Guide.md +++ b/docs/OSAL-Configuration-Guide.md @@ -76,7 +76,7 @@ The following sections provide instructions on how to: - Configure the build directory for an OSAL application -- Configure a OSAL Application +- Configure an OSAL Application - Build the OSAL Application @@ -135,7 +135,7 @@ Most parameters set upper bounds on the number of OS objects that can be created the OSAL keeps track of allocated OS objects using fixed size tables. If customization is desired, one should not modify the `default_config.cmake` file directly, -but rather provide a alternative values by one of the override methods: +but rather provide alternative values by one of the override methods: - If configuring OSAL as a standalone build for testing, values for options can be specified as `-D` options on the cmake command. This is a common method of specifying @@ -486,13 +486,13 @@ software to remain portable. There are a few ways to map these host file systems to OSAL file systems: -- **Map existing target file systems to a OSAL path**. This is one of +- **Map existing target file systems to an OSAL path**. This is one of the most common ways to map the Non-Volatile disk to the OSAL. The OSAL relies on the target OS to create/mount a file system and it simply is given a mapping to the disk to allow the OSAL to access it. - **Create EEPROM/Flash/ATA File systems**. The OSAL has the ability -on some targets to format or initialize a EEPROM or ATA disk device. +on some targets to format or initialize an EEPROM or ATA disk device. This is less commonly used. - **Create RAM File Systems**. The OSAL can create RAM disks on the @@ -510,7 +510,7 @@ mappings via API calls during its startup. This may be done any time after call `OS_API_Init()`. For example, for Core Flight System (cFS) configurations that require persistent -storage to be provided under a virual directory called `/cf`, the platform-specific +storage to be provided under a virtual directory called `/cf`, the platform-specific CFE PSP layer configures the mapping in an appropriate manner by calling the `OS_FileSysAddFixedMap()` API during its OS_Application_Startup() implementation. @@ -633,14 +633,14 @@ qemu-system-i386 -m 128 -no-reboot -display none -serial stdio \ ``` Where `.exe` refers to any of the test programs or applications -that are provided with OSAL. This command puts the virual console on +that are provided with OSAL. This command puts the virtual console on the same terminal where the QEMU emulator is started. The program should run automatically after the kernel boots. The system may be stopped by issuing the "shutdown" command at the shell, or by pressing the CTRL+A followed by CTRL+C which terminates QEMU. -## Generc Linux Platform +## Generic Linux Platform The OSAL can run on many Linux distributions. Testing is done with currently supported Ubuntu LTS versions (up through 20.04 at the time of the current @@ -690,7 +690,7 @@ each OSAL subsystem is specially compiled with special flags to enable profiling (to track line and branch coverage) and linked with _stub_ implementations of all other dependencies. This way, test cases can trigger error paths from library calls that would otherwise not be possible -in a black box test enviornment. +in a black box test environment. These test programs are executed just as any other application program. @@ -720,7 +720,7 @@ the test programs will be copied to the output location/staging area. ### Option 1: Execute single test directly from a build tree The tests can be executed directly in-place in the build directory. This method often useful -when debugging, as the exectuable can also be run in a debugger (i.e. gdb) this way. +when debugging, as the executable can also be run in a debugger (i.e. gdb) this way. The following example executes the task subsystem coverage test for the shared layer, but any other test can be run in a similar fashion. diff --git a/docs/src/osal_fs.dox b/docs/src/osal_fs.dox index 6a8b8cf29..c909055ba 100644 --- a/docs/src/osal_fs.dox +++ b/docs/src/osal_fs.dox @@ -74,8 +74,8 @@ instance, the path of the file that the file descriptor points to can be easily to determine statistics for a task, or the entire system. This information can all be retrieved with a single API, OS_FDGetInfo. - All of possible file system calls are not implemented. "Special" files requiring OS - specific control/operations are by nature not portable. Abstraction in this case is + All of the possible file system calls are not implemented. "Special" files requiring + OS specific control/operations are by nature not portable. Abstraction in this case is not possible, so the raw OS calls should be used (including open/close/etc). Mixing with OSAL calls is not supported for such cases. #OS_TranslatePath is available to support using open directly by an app and maintain abstraction on the file system. diff --git a/src/bsp/generic-linux/src/bsp_start.c b/src/bsp/generic-linux/src/bsp_start.c index 67e21158d..5f10c7126 100644 --- a/src/bsp/generic-linux/src/bsp_start.c +++ b/src/bsp/generic-linux/src/bsp_start.c @@ -136,7 +136,7 @@ void OS_BSP_Unlock_Impl(void) } else { - /* Restore previous cancelability state */ + /* Restore previous cancellability state */ pthread_setcancelstate(OS_BSP_GenericLinuxGlobal.AccessCancelState, NULL); } } @@ -212,7 +212,7 @@ int main(int argc, char *argv[]) * Note that the first argument (0) is the command name. The * first "real" argument is at position 1. * - * However this still needs to pass it through as the appliction + * However this still needs to pass it through as the application * might still want to use library "getopt" and this expects the * first parameter to be this way. */ diff --git a/src/bsp/generic-vxworks/src/bsp_start.c b/src/bsp/generic-vxworks/src/bsp_start.c index 07e9e107c..89eb34cdc 100644 --- a/src/bsp/generic-vxworks/src/bsp_start.c +++ b/src/bsp/generic-vxworks/src/bsp_start.c @@ -108,7 +108,7 @@ int OS_BSPMain(void) if (OS_BSP_GenericVxWorksGlobal.AccessMutex == (SEM_ID)0) { - BSP_DEBUG("semMInitalize: errno=%d\n", errno); + BSP_DEBUG("semMInitialize: errno=%d\n", errno); } /* diff --git a/src/bsp/pc-rtems/src/bsp_start.c b/src/bsp/pc-rtems/src/bsp_start.c index 1d0ef9789..f3c9cfa67 100644 --- a/src/bsp/pc-rtems/src/bsp_start.c +++ b/src/bsp/pc-rtems/src/bsp_start.c @@ -101,7 +101,7 @@ void OS_BSP_Setup(void) * Known arguments are handled here, and unknown args are * saved for the UT application. * - * Batch mode is intended for non-interative execution. + * Batch mode is intended for non-interactive execution. * * It does two things: * - do not start the shell task @@ -385,7 +385,7 @@ rtems_task Init(rtems_task_argument ignored) /* configuration information */ /* -** RTEMS OS Configuration defintions +** RTEMS OS Configuration definitions */ #define TASK_INTLEVEL 0 #define CONFIGURE_INIT diff --git a/src/bsp/shared/inc/bsp-impl.h b/src/bsp/shared/inc/bsp-impl.h index d2e7cfcbc..bb7d4a16f 100644 --- a/src/bsp/shared/inc/bsp-impl.h +++ b/src/bsp/shared/inc/bsp-impl.h @@ -113,7 +113,7 @@ extern OS_BSP_GlobalData_t OS_BSP_Global; Purpose: Get exclusive access to a BSP-provided service or object - Useful in conjuction with console output functions to avoid strings + Useful in conjunction with console output functions to avoid strings from multiple tasks getting mixed together in the final output. ------------------------------------------------------------------*/ diff --git a/src/os/inc/osapi-common.h b/src/os/inc/osapi-common.h index 4f1659d9c..26b389257 100644 --- a/src/os/inc/osapi-common.h +++ b/src/os/inc/osapi-common.h @@ -150,7 +150,7 @@ int32 OS_API_Init(void); * * Normally for embedded applications, the OSAL is initialized after boot and will remain * initialized in memory until the processor is rebooted. However for testing and - * developement purposes, it is potentially useful to reset back to initial conditions. + * development purposes, it is potentially useful to reset back to initial conditions. * * For testing purposes, this API is designed/intended to be compatible with the * UtTest_AddTeardown() routine provided by the UT-Assert subsystem. diff --git a/src/os/inc/osapi-file.h b/src/os/inc/osapi-file.h index b16a45e18..78871f848 100644 --- a/src/os/inc/osapi-file.h +++ b/src/os/inc/osapi-file.h @@ -306,7 +306,7 @@ int32 OS_chmod(const char *path, uint32 access_mode); /** * @brief Obtain information about a file or directory * - * Returns information about a file or directory in a os_fstat_t structure + * Returns information about a file or directory in an os_fstat_t structure * * @param[in] path The file to operate on @nonnull * @param[out] filestats Buffer to store file information @nonnull @@ -344,9 +344,9 @@ int32 OS_lseek(osal_id_t filedes, int32 offset, uint32 whence); * * Removes a given filename from the drive * - * @note The behvior of this API on an open file is not defined at the OSAL level + * @note The behavior of this API on an open file is not defined at the OSAL level * due to dependencies on the underlying OS which may or may not allow the related - * operation based on a varienty of potential configurations. For portability, + * operation based on a variety of potential configurations. For portability, * it is recommended that applications ensure the file is closed prior to removal. * * @param[in] path The file to operate on @nonnull @@ -368,9 +368,9 @@ int32 OS_remove(const char *path); * Changes the name of a file, where the source and destination * reside on the same file system. * - * @note The behvior of this API on an open file is not defined at the OSAL level + * @note The behavior of this API on an open file is not defined at the OSAL level * due to dependencies on the underlying OS which may or may not allow the related - * operation based on a varienty of potential configurations. For portability, + * operation based on a variety of potential configurations. For portability, * it is recommended that applications ensure the file is closed prior to removal. * * @param[in] old_filename The original filename @nonnull @@ -390,9 +390,9 @@ int32 OS_rename(const char *old_filename, const char *new_filename); /** * @brief Copies a single file from src to dest * - * @note The behvior of this API on an open file is not defined at the OSAL level + * @note The behavior of this API on an open file is not defined at the OSAL level * due to dependencies on the underlying OS which may or may not allow the related - * operation based on a varienty of potential configurations. For portability, + * operation based on a variety of potential configurations. For portability, * it is recommended that applications ensure the file is closed prior to removal. * * @param[in] src The source file to operate on @nonnull @@ -418,9 +418,9 @@ int32 OS_cp(const char *src, const char *dest); * If this fails, it falls back to copying the file and removing * the original. * - * @note The behvior of this API on an open file is not defined at the OSAL level + * @note The behavior of this API on an open file is not defined at the OSAL level * due to dependencies on the underlying OS which may or may not allow the related - * operation based on a varienty of potential configurations. For portability, + * operation based on a variety of potential configurations. For portability, * it is recommended that applications ensure the file is closed prior to removal. * * @param[in] src The source file to operate on @nonnull diff --git a/src/os/inc/osapi-filesys.h b/src/os/inc/osapi-filesys.h index 58ca0ffbf..4330ce534 100644 --- a/src/os/inc/osapi-filesys.h +++ b/src/os/inc/osapi-filesys.h @@ -270,7 +270,7 @@ int32 OS_FS_GetPhysDriveName(char *PhysDriveName, const char *MountPoint); /*-------------------------------------------------------------------------------------*/ /** - * @brief Translates a OSAL Virtual file system path to a host Local path + * @brief Translates an OSAL Virtual file system path to a host Local path * * Translates a virtual path to an actual system path name * diff --git a/src/os/inc/osapi-idmap.h b/src/os/inc/osapi-idmap.h index cf7e4c361..93048c4b9 100644 --- a/src/os/inc/osapi-idmap.h +++ b/src/os/inc/osapi-idmap.h @@ -66,7 +66,7 @@ * * The returned value is of the type "unsigned long" for direct use with * printf-style functions. It is recommended to use the "%lx" conversion - * specifier as the hexidecimal encoding clearly delineates the internal fields. + * specifier as the hexadecimal encoding clearly delineates the internal fields. * * @note This provides the raw integer value and is _not_ suitable for use * as an array index, as the result is not zero-based. See the diff --git a/src/os/inc/osapi-macros.h b/src/os/inc/osapi-macros.h index 594ddee7f..5f94e116f 100644 --- a/src/os/inc/osapi-macros.h +++ b/src/os/inc/osapi-macros.h @@ -57,7 +57,7 @@ #ifdef OSAL_CONFIG_BUGCHECK_STRICT /* - * This BUGREPORT implementation aborts the application so that the applicaiton + * This BUGREPORT implementation aborts the application so that the application * can be debugged immediately. This prints the message direct to stderr, which is * typically not buffered, so it should appear on the console before the abort occurs, * but may appear out of order with respect to calls to OS_printf(). @@ -114,7 +114,7 @@ * which may (validly) occur at runtime and do not necessarily indicate bugs in the * application. * - * These argument checks are NOT considered a fatal errors. The application + * These argument checks are NOT considered fatal errors. The application * continues to run normally. This does not report the error on the console. * * As such, ARGCHECK actions are always compiled in - not selectable at compile-time. diff --git a/src/os/inc/osapi-module.h b/src/os/inc/osapi-module.h index ed5c52c5b..376bd87f1 100644 --- a/src/os/inc/osapi-module.h +++ b/src/os/inc/osapi-module.h @@ -55,8 +55,8 @@ * * When supplied as the "flags" argument to OS_ModuleLoad(), this indicates * that the symbols in the loaded module should NOT be added to the global - * symbol table. This means the symbols in the loaded library will not available - * to for use by other modules. + * symbol table. This means the symbols in the loaded library will not be + * available for use by other modules. * * Use this option is recommended for cases where no other entities will need * to reference symbols within this module. This helps ensure that the module diff --git a/src/os/inc/osapi-queue.h b/src/os/inc/osapi-queue.h index 874f368b7..2792cd36c 100644 --- a/src/os/inc/osapi-queue.h +++ b/src/os/inc/osapi-queue.h @@ -105,7 +105,7 @@ int32 OS_QueueDelete(osal_id_t queue_id); * @retval #OS_SUCCESS @copybrief OS_SUCCESS * @retval #OS_ERR_INVALID_ID if the given ID does not exist * @retval #OS_INVALID_POINTER if a pointer passed in is NULL - * @retval #OS_QUEUE_EMPTY if the Queue has no messages on it to be recieved + * @retval #OS_QUEUE_EMPTY if the Queue has no messages on it to be received * @retval #OS_QUEUE_TIMEOUT if the timeout was OS_PEND and the time expired * @retval #OS_QUEUE_INVALID_SIZE if the size copied from the queue was not correct * @retval #OS_ERROR if the OS call returns an unexpected error @covtest diff --git a/src/os/inc/osapi-select.h b/src/os/inc/osapi-select.h index c46fd4750..012bf62bd 100644 --- a/src/os/inc/osapi-select.h +++ b/src/os/inc/osapi-select.h @@ -70,7 +70,7 @@ typedef enum /** * @brief Wait for events across multiple file handles * - * Wait for any of the given sets of IDs to be become readable or writable + * Wait for any of the given sets of IDs to become readable or writable * * This function will block until any of the following occurs: * - At least one OSAL ID in the ReadSet is readable diff --git a/src/os/inc/osapi-sockets.h b/src/os/inc/osapi-sockets.h index ca7e9622f..266887fa2 100644 --- a/src/os/inc/osapi-sockets.h +++ b/src/os/inc/osapi-sockets.h @@ -134,7 +134,7 @@ typedef struct * is (mostly) agnostic to the actual network address type. * * Every network address should be representable as a string (i.e. dotted decimal IP, etc). - * This can serve as a the "common denominator" to all address types. + * This can serve as the "common denominator" to all address types. * * @{ */ @@ -208,7 +208,7 @@ int32 OS_SocketAddrFromString(OS_SockAddr_t *Addr, const char *string); /** * @brief Get the port number of a network address * - * For network prototcols that have the concept of a port number (such + * For network protocols that have the concept of a port number (such * as TCP/IP and UDP/IP) this function gets the port number from the * address structure. * @@ -226,7 +226,7 @@ int32 OS_SocketAddrGetPort(uint16 *PortNum, const OS_SockAddr_t *Addr); /** * @brief Set the port number of a network address * - * For network prototcols that have the concept of a port number (such + * For network protocols that have the concept of a port number (such * as TCP/IP and UDP/IP) this function sets the port number from the * address structure. * diff --git a/src/os/inc/osapi-version.h b/src/os/inc/osapi-version.h index 679edaee0..5c54397c9 100644 --- a/src/os/inc/osapi-version.h +++ b/src/os/inc/osapi-version.h @@ -49,7 +49,7 @@ /*! * @brief Mission revision. * - * Set to 0 on OFFIFICIAL releases, and set to 255 (0xFF) on development versions. + * Set to 0 on OFFICIAL releases, and set to 255 (0xFF) on development versions. * Values 1-254 are reserved for mission use to denote patches/customizations as needed. */ #define OS_MISSION_REV 0xFF diff --git a/src/os/portable/README.txt b/src/os/portable/README.txt index 1f7ffd425..f4d985249 100644 --- a/src/os/portable/README.txt +++ b/src/os/portable/README.txt @@ -1,4 +1,4 @@ -Files in this directory contain an implmentation that adheres to a defined API +Files in this directory contain an implementation that adheres to a defined API that is applicable to more than one of the supported OS's, but not all. For example, the BSD-style sockets API is implemented in VxWorks, RTEMS, and Linux. Therefore it is beneficial to put the code in here and let each implementation diff --git a/src/os/portable/os-impl-bsd-sockets.c b/src/os/portable/os-impl-bsd-sockets.c index e7da995cb..cb31211a6 100644 --- a/src/os/portable/os-impl-bsd-sockets.c +++ b/src/os/portable/os-impl-bsd-sockets.c @@ -22,7 +22,7 @@ * \file os-impl-bsd-sockets.c * \author joseph.p.hickey@nasa.gov * - * Purpose: This file contains the network functionality for for + * Purpose: This file contains the network functionality for * systems which implement the BSD-style socket API. */ @@ -77,7 +77,7 @@ typedef union * Confirm that the abstract socket address buffer size (OS_SOCKADDR_MAX_LEN) is * large enough to store any of the enabled address types. If this is true, the * size of the above union will match OS_SOCKADDR_MAX_LEN. However, if any - * implemention-provided struct types are larger than this, the union will be + * implementation-provided struct types are larger than this, the union will be * larger, and this indicates a configuration error. */ CompileTimeAssert(sizeof(OS_SockAddr_Accessor_t) == OS_SOCKADDR_MAX_LEN, SockAddrSize); diff --git a/src/os/posix/inc/os-impl-gettime.h b/src/os/posix/inc/os-impl-gettime.h index a15ae3a78..c75251080 100644 --- a/src/os/posix/inc/os-impl-gettime.h +++ b/src/os/posix/inc/os-impl-gettime.h @@ -32,7 +32,7 @@ #include /** - * \brief Idenfies the clock ID for OSAL clock operations on POSIX + * \brief Identifies the clock ID for OSAL clock operations on POSIX * * This is the POSIX clock ID that will be used to implement * OS_GetLocalTime() and OS_SetLocalTime(). diff --git a/src/os/posix/src/os-impl-binsem.c b/src/os/posix/src/os-impl-binsem.c index 42999931a..c794407ce 100644 --- a/src/os/posix/src/os-impl-binsem.c +++ b/src/os/posix/src/os-impl-binsem.c @@ -37,7 +37,7 @@ #include "os-impl-binsem.h" /* - * This controls the maximum time the that the calling thread will wait to + * This controls the maximum time that the calling thread will wait to * acquire the condition mutex before returning an error. * * Under normal conditions, this lock is held by giving/taking threads very @@ -495,7 +495,7 @@ int32 OS_BinSemGetInfo_Impl(const OS_object_token_t *token, OS_bin_sem_prop_t *s sem = OS_OBJECT_TABLE_GET(OS_impl_bin_sem_table, *token); - /* put the info into the stucture */ + /* put the info into the structure */ sem_prop->value = sem->current_value; return OS_SUCCESS; } /* end OS_BinSemGetInfo_Impl */ diff --git a/src/os/posix/src/os-impl-countsem.c b/src/os/posix/src/os-impl-countsem.c index dac78b6ab..ea79b88e3 100644 --- a/src/os/posix/src/os-impl-countsem.c +++ b/src/os/posix/src/os-impl-countsem.c @@ -221,7 +221,7 @@ int32 OS_CountSemGetInfo_Impl(const OS_object_token_t *token, OS_count_sem_prop_ return OS_SEM_FAILURE; } - /* put the info into the stucture */ + /* put the info into the structure */ count_prop->value = sval; return OS_SUCCESS; } /* end OS_CountSemGetInfo_Impl */ diff --git a/src/os/posix/src/os-impl-timebase.c b/src/os/posix/src/os-impl-timebase.c index 1c35b0279..fd30f78fa 100644 --- a/src/os/posix/src/os-impl-timebase.c +++ b/src/os/posix/src/os-impl-timebase.c @@ -57,7 +57,7 @@ static void OS_UsecToTimespec(uint32 usecs, struct timespec *time_spec); ***************************************************************************************/ /* - * Prefer to use the MONOTONIC clock if available, as it will not get distrupted by setting + * Prefer to use the MONOTONIC clock if available, as it will not get disrupted by setting * the time like the REALTIME clock will. */ #ifndef OS_PREFERRED_CLOCK diff --git a/src/os/rtems/inc/os-impl-gettime.h b/src/os/rtems/inc/os-impl-gettime.h index 701e0c130..fb8b303fb 100644 --- a/src/os/rtems/inc/os-impl-gettime.h +++ b/src/os/rtems/inc/os-impl-gettime.h @@ -32,7 +32,7 @@ #include /** - * \brief Idenfies the clock ID for OSAL clock operations on RTEMS + * \brief Identifies the clock ID for OSAL clock operations on RTEMS * * This is the POSIX clock ID that will be used to implement * OS_GetLocalTime() and OS_SetLocalTime(). diff --git a/src/os/rtems/src/os-impl-console.c b/src/os/rtems/src/os-impl-console.c index ce3ee18c8..02458693a 100644 --- a/src/os/rtems/src/os-impl-console.c +++ b/src/os/rtems/src/os-impl-console.c @@ -172,7 +172,7 @@ int32 OS_ConsoleCreate_Impl(const OS_object_token_t *token) /* check if task_create failed */ if (status != RTEMS_SUCCESSFUL) { - /* Provide some freedback as to why this failed */ + /* Provide some feedback as to why this failed */ OS_DEBUG("rtems_task_create failed: %s\n", rtems_status_text(status)); rtems_semaphore_delete(local->data_sem); return_code = OS_ERROR; diff --git a/src/os/rtems/src/os-impl-loader.c b/src/os/rtems/src/os-impl-loader.c index dd986511d..3c36c672e 100644 --- a/src/os/rtems/src/os-impl-loader.c +++ b/src/os/rtems/src/os-impl-loader.c @@ -144,7 +144,7 @@ int32 OS_ModuleLoad_Impl(const OS_object_token_t *token, const char *translated_ * is acceptable. If not acceptable, it sets the status back to an error. */ - OS_DEBUG("module has has unresolved externals\n"); + OS_DEBUG("Module has unresolved externals\n"); status = OS_SUCCESS; /* note - not final, probably overridden */ OSAL_UNRESOLVED_ITERATE(OS_rtems_rtl_check_unresolved, &status); } diff --git a/src/os/rtems/src/os-impl-tasks.c b/src/os/rtems/src/os-impl-tasks.c index 675ac50a5..99407107c 100644 --- a/src/os/rtems/src/os-impl-tasks.c +++ b/src/os/rtems/src/os-impl-tasks.c @@ -127,7 +127,7 @@ int32 OS_TaskCreate_Impl(const OS_object_token_t *token, uint32 flags) /* check if task_create failed */ if (status != RTEMS_SUCCESSFUL) { - /* Provide some freedback as to why this failed */ + /* Provide some feedback as to why this failed */ OS_printf("rtems_task_create failed: %s\n", rtems_status_text(status)); return OS_ERROR; } diff --git a/src/os/rtems/src/os-impl-timebase.c b/src/os/rtems/src/os-impl-timebase.c index 2c59cdc29..b85151630 100644 --- a/src/os/rtems/src/os-impl-timebase.c +++ b/src/os/rtems/src/os-impl-timebase.c @@ -49,7 +49,7 @@ void OS_UsecsToTicks(uint32 usecs, rtems_interval *ticks); ***************************************************************************************/ /* - * Prefer to use the MONOTONIC clock if available, as it will not get distrupted by setting + * Prefer to use the MONOTONIC clock if available, as it will not get disrupted by setting * the time like the REALTIME clock will. */ #ifndef OS_PREFERRED_CLOCK @@ -385,7 +385,7 @@ int32 OS_TimeBaseCreate_Impl(const OS_object_token_t *token) /* check if task_create failed */ if (rtems_sc != RTEMS_SUCCESSFUL) { - /* Provide some freedback as to why this failed */ + /* Provide some feedback as to why this failed */ OS_printf("rtems_task_create failed: %s\n", rtems_status_text(rtems_sc)); return_code = OS_TIMER_ERR_INTERNAL; } diff --git a/src/os/shared/inc/os-shared-common.h b/src/os/shared/inc/os-shared-common.h index c6cb302fc..cbc6b4e5c 100644 --- a/src/os/shared/inc/os-shared-common.h +++ b/src/os/shared/inc/os-shared-common.h @@ -98,7 +98,7 @@ int32 OS_NotifyEvent(OS_Event_t event, osal_id_t object_id, void *data); int32 OS_API_Impl_Init(osal_objtype_t idtype); /* - * This functions implement a the OS-specific portion + * This function implements the OS-specific portion * of various OSAL functions. They are defined in * OS-specific source files. */ diff --git a/src/os/shared/inc/os-shared-console.h b/src/os/shared/inc/os-shared-console.h index ccba744f6..d3cd32210 100644 --- a/src/os/shared/inc/os-shared-console.h +++ b/src/os/shared/inc/os-shared-console.h @@ -87,7 +87,7 @@ int32 OS_ConsoleCreate_Impl(const OS_object_token_t *token); This is a notification API that is invoked whenever there is new data available in the console output buffer. - It is only used of the console is configured for async operation, + It is only used if the console is configured for async operation, and it should wakeup the actual console servicing thread. ------------------------------------------------------------------*/ void OS_ConsoleWakeup_Impl(const OS_object_token_t *token); diff --git a/src/os/shared/inc/os-shared-filesys.h b/src/os/shared/inc/os-shared-filesys.h index 190ce4cde..1ea87cba6 100644 --- a/src/os/shared/inc/os-shared-filesys.h +++ b/src/os/shared/inc/os-shared-filesys.h @@ -77,7 +77,7 @@ enum { OS_FILESYS_TYPE_UNKNOWN = 0, /**< Unspecified or unknown file system type */ - OS_FILESYS_TYPE_FS_BASED, /**< A emulated virtual file system that maps to another file system location */ + OS_FILESYS_TYPE_FS_BASED, /**< An emulated virtual file system that maps to another file system location */ OS_FILESYS_TYPE_NORMAL_DISK, /**< A traditional disk drive or something that emulates one */ OS_FILESYS_TYPE_VOLATILE_DISK, /**< A temporary/volatile file system or RAM disk */ OS_FILESYS_TYPE_MTD, /**< A "memory technology device" such as FLASH or EEPROM */ diff --git a/src/os/shared/inc/os-shared-idmap.h b/src/os/shared/inc/os-shared-idmap.h index 4eab9e44e..4fb87c862 100644 --- a/src/os/shared/inc/os-shared-idmap.h +++ b/src/os/shared/inc/os-shared-idmap.h @@ -75,8 +75,8 @@ typedef enum } OS_lock_mode_t; /* - * A unique key value issued when obtaining a table lock, based on a - * the a combination of the requesting task ID and a transaction ID + * A unique key value issued when obtaining a table lock, based on + * a combination of the requesting task ID and a transaction ID */ typedef struct { @@ -233,7 +233,7 @@ void OS_WaitForStateChange(OS_object_token_t *token, uint32 attempts); another thread. It is not guaranteed what, if any, state change has actually - occured when this function returns. This may be implement as + occurred when this function returns. This may be implemented as a simple OS_TaskDelay(). ------------------------------------------------------------------*/ @@ -454,7 +454,7 @@ void OS_ObjectIdRelease(OS_object_token_t *token); /*---------------------------------------------------------------- Function: OS_ObjectIdTransferToken - Purpose: Transfers ownership of a object token without unlocking/releasing. + Purpose: Transfers ownership of an object token without unlocking/releasing. The original token will become benign and the new token becomes active. Returns: none @@ -512,7 +512,7 @@ int32 OS_ObjectIdIteratorInit(OS_ObjectMatchFunc_t matchfunc, void *matcharg, os /*---------------------------------------------------------------- Function: OS_ObjectIdIterateActive - Purpose: Initialize a object iterator of the given type that will + Purpose: Initialize an object iterator of the given type that will return only active/valid OSAL objects. Returns: OS_SUCCESS on success, or relevant error code diff --git a/src/os/shared/src/osapi-binsem.c b/src/os/shared/src/osapi-binsem.c index e498db02f..c068f529c 100644 --- a/src/os/shared/src/osapi-binsem.c +++ b/src/os/shared/src/osapi-binsem.c @@ -43,7 +43,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_BIN_SEMAPHORES) || (OS_MAX_BIN_SEMAPHORES <= 0) #error "osconfig.h must define OS_MAX_BIN_SEMAPHORES to a valid value" diff --git a/src/os/shared/src/osapi-countsem.c b/src/os/shared/src/osapi-countsem.c index 9eebafc84..c8208ae6d 100644 --- a/src/os/shared/src/osapi-countsem.c +++ b/src/os/shared/src/osapi-countsem.c @@ -43,7 +43,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_COUNT_SEMAPHORES) || (OS_MAX_COUNT_SEMAPHORES <= 0) #error "osconfig.h must define OS_MAX_COUNT_SEMAPHORES to a valid value" diff --git a/src/os/shared/src/osapi-debug.c b/src/os/shared/src/osapi-debug.c index 5a3e2fa5f..f67fe48dc 100644 --- a/src/os/shared/src/osapi-debug.c +++ b/src/os/shared/src/osapi-debug.c @@ -25,7 +25,7 @@ * * Contains the implementation for OS_DEBUG(). * - * This is only compiled in when OSAL_CONFIG_DEBUG_PRINTF is enabled. + * This is only compiled when OSAL_CONFIG_DEBUG_PRINTF is enabled. */ /**************************************************************************************** diff --git a/src/os/shared/src/osapi-dir.c b/src/os/shared/src/osapi-dir.c index 0a296306e..90eab3223 100644 --- a/src/os/shared/src/osapi-dir.c +++ b/src/os/shared/src/osapi-dir.c @@ -45,7 +45,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_NUM_OPEN_DIRS) || (OS_MAX_NUM_OPEN_DIRS <= 0) #error "osconfig.h must define OS_MAX_NUM_OPEN_DIRS to a valid value" diff --git a/src/os/shared/src/osapi-file.c b/src/os/shared/src/osapi-file.c index 0e8a28bdb..c2d3191b6 100644 --- a/src/os/shared/src/osapi-file.c +++ b/src/os/shared/src/osapi-file.c @@ -49,7 +49,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_NUM_OPEN_FILES) || (OS_MAX_NUM_OPEN_FILES <= 0) #error "osconfig.h must define OS_MAX_NUM_OPEN_FILES to a valid value" diff --git a/src/os/shared/src/osapi-filesys.c b/src/os/shared/src/osapi-filesys.c index 68eb5f438..f2a77f264 100644 --- a/src/os/shared/src/osapi-filesys.c +++ b/src/os/shared/src/osapi-filesys.c @@ -348,7 +348,7 @@ int32 OS_mkfs(char *address, const char *devname, const char *volname, size_t bl /* * This is the historic filesystem-specific error code generated when * attempting to mkfs()/initfs() on a filesystem that was - * already initialized, or of there were no free slots in the table. + * already initialized, or if there were no free slots in the table. * * This code preserved just in case application code was checking for it. */ @@ -418,7 +418,7 @@ int32 OS_initfs(char *address, const char *devname, const char *volname, size_t /* * This is the historic filesystem-specific error code generated when * attempting to mkfs()/initfs() on a filesystem that was - * already initialized, or of there were no free slots in the table. + * already initialized, or if there were no free slots in the table. * * This code preserved just in case application code was checking for it. */ diff --git a/src/os/shared/src/osapi-idmap.c b/src/os/shared/src/osapi-idmap.c index c66b93237..725cbbdf0 100644 --- a/src/os/shared/src/osapi-idmap.c +++ b/src/os/shared/src/osapi-idmap.c @@ -1003,7 +1003,7 @@ int32 OS_ObjectIdFindByName(osal_objtype_t idtype, const char *name, osal_id_t * OS_object_token_t token; /* - * As this is an internal-only function, calling it will NULL is allowed. + * As this is an internal-only function, calling it with NULL is allowed. * This is required by the file/dir/socket API since these DO allow multiple * instances of the same name. */ @@ -1031,7 +1031,7 @@ int32 OS_ObjectIdFindByName(osal_objtype_t idtype, const char *name, osal_id_t * * If successful, this returns with the item locked according to "lock_mode". * * IMPORTANT: when this function returns OS_SUCCESS with lock_mode something - * other than NONE, then the caller must take appropriate action to UN lock + * other than NONE, then the caller must take appropriate action to UNLOCK * after completing the respective operation. The OS_ObjectIdRelease() * function may be used to release the lock appropriately for the lock_mode. * @@ -1056,7 +1056,7 @@ int32 OS_ObjectIdGetById(OS_lock_mode_t lock_mode, osal_objtype_t idtype, osal_i /* * The "ConvertToken" routine will return with the global lock * in a state appropriate for returning to the caller, as indicated - * by the "check_mode" paramter. + * by the "check_mode" parameter. * * Note If this operation fails, then it always unlocks the global for * all check_mode's other than NONE. @@ -1209,7 +1209,7 @@ int32 OS_ObjectIdAllocateNew(osal_objtype_t idtype, const char *name, OS_object_ } /* - * Check if an object of the same name already exits. + * Check if an object of the same name already exists. * If so, a new object cannot be allocated. */ if (name != NULL) diff --git a/src/os/shared/src/osapi-module.c b/src/os/shared/src/osapi-module.c index 23ddc0126..720da42ed 100644 --- a/src/os/shared/src/osapi-module.c +++ b/src/os/shared/src/osapi-module.c @@ -48,7 +48,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_MODULES) || (OS_MAX_MODULES <= 0) #error "osconfig.h must define OS_MAX_MODULES to a valid value" diff --git a/src/os/shared/src/osapi-mutex.c b/src/os/shared/src/osapi-mutex.c index fb07100cd..70c651db0 100644 --- a/src/os/shared/src/osapi-mutex.c +++ b/src/os/shared/src/osapi-mutex.c @@ -48,7 +48,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_MUTEXES) || (OS_MAX_MUTEXES <= 0) #error "osconfig.h must define OS_MAX_MUTEXES to a valid value" diff --git a/src/os/shared/src/osapi-queue.c b/src/os/shared/src/osapi-queue.c index 24a303577..c3a351934 100644 --- a/src/os/shared/src/osapi-queue.c +++ b/src/os/shared/src/osapi-queue.c @@ -47,7 +47,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_QUEUES) || (OS_MAX_QUEUES <= 0) #error "osconfig.h must define OS_MAX_QUEUES to a valid value" diff --git a/src/os/shared/src/osapi-task.c b/src/os/shared/src/osapi-task.c index 9124b1349..abeb839c4 100644 --- a/src/os/shared/src/osapi-task.c +++ b/src/os/shared/src/osapi-task.c @@ -49,7 +49,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_TASKS) || (OS_MAX_TASKS <= 0) #error "osconfig.h must define OS_MAX_TASKS to a valid value" diff --git a/src/os/shared/src/osapi-time.c b/src/os/shared/src/osapi-time.c index c196ec003..89b624399 100644 --- a/src/os/shared/src/osapi-time.c +++ b/src/os/shared/src/osapi-time.c @@ -48,7 +48,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_TIMERS) || (OS_MAX_TIMERS <= 0) #error "osconfig.h must define OS_MAX_TIMERS to a valid value" diff --git a/src/os/shared/src/osapi-timebase.c b/src/os/shared/src/osapi-timebase.c index a7918852a..f6ba02f49 100644 --- a/src/os/shared/src/osapi-timebase.c +++ b/src/os/shared/src/osapi-timebase.c @@ -50,7 +50,7 @@ /* * Sanity checks on the user-supplied configuration - * The relevent OS_MAX limit should be defined and greater than zero + * The relevant OS_MAX limit should be defined and greater than zero */ #if !defined(OS_MAX_TIMEBASES) || (OS_MAX_TIMEBASES <= 0) #error "osconfig.h must define OS_MAX_TIMEBASES to a valid value" diff --git a/src/os/vxworks/inc/os-impl-gettime.h b/src/os/vxworks/inc/os-impl-gettime.h index fcd1ded7b..980275605 100644 --- a/src/os/vxworks/inc/os-impl-gettime.h +++ b/src/os/vxworks/inc/os-impl-gettime.h @@ -32,7 +32,7 @@ #include /** - * \brief Idenfies the clock ID for OSAL clock operations on VxWorks + * \brief Identifies the clock ID for OSAL clock operations on VxWorks * * This is the POSIX clock ID that will be used to implement * OS_GetLocalTime() and OS_SetLocalTime(). diff --git a/src/os/vxworks/src/os-impl-filesys.c b/src/os/vxworks/src/os-impl-filesys.c index 5352e8563..638279e0e 100644 --- a/src/os/vxworks/src/os-impl-filesys.c +++ b/src/os/vxworks/src/os-impl-filesys.c @@ -105,7 +105,7 @@ int32 OS_FileSysStartVolume_Impl(const OS_object_token_t *token) /* ** Create the ram disk device ** The 32 is the number of blocks per track. - ** Other values dont seem to work here + ** Other values don't seem to work here */ impl->blkDev = ramDevCreate(local->address, local->blocksize, 32, local->numblocks, 0); impl->xbdMaxPartitions = 1; diff --git a/src/os/vxworks/src/os-impl-mutex.c b/src/os/vxworks/src/os-impl-mutex.c index d044e5bed..4b0f64271 100644 --- a/src/os/vxworks/src/os-impl-mutex.c +++ b/src/os/vxworks/src/os-impl-mutex.c @@ -81,7 +81,7 @@ int32 OS_MutSemCreate_Impl(const OS_object_token_t *token, uint32 options) if (tmp_sem_id == (SEM_ID)0) { - OS_DEBUG("semMInitalize() - vxWorks errno %d\n", errno); + OS_DEBUG("semMInitialize() - vxWorks errno %d\n", errno); return OS_SEM_FAILURE; } diff --git a/src/os/vxworks/src/os-impl-timebase.c b/src/os/vxworks/src/os-impl-timebase.c index 959376ff3..a68494c6b 100644 --- a/src/os/vxworks/src/os-impl-timebase.c +++ b/src/os/vxworks/src/os-impl-timebase.c @@ -48,7 +48,7 @@ DEFINES ****************************************************************************************/ -/* Each "timebase" resource spawns an dedicated servicing task- +/* Each "timebase" resource spawns a dedicated servicing task- * this task (not the timer ISR) is the context that calls back to * the user application. * @@ -60,7 +60,7 @@ #define OSAL_TIMEBASE_REG_WAIT_LIMIT 100 /* - * Prefer to use the MONOTONIC clock if available, as it will not get distrupted by setting + * Prefer to use the MONOTONIC clock if available, as it will not get disrupted by setting * the time like the REALTIME clock will. */ #ifndef OS_PREFERRED_CLOCK diff --git a/src/tests/file-api-test/README.txt b/src/tests/file-api-test/README.txt index b8b0b07c9..948801543 100644 --- a/src/tests/file-api-test/README.txt +++ b/src/tests/file-api-test/README.txt @@ -4,7 +4,7 @@ test2.c is designed to test the functionality of the functions provided in osfil The modules are separate and independent. Each does not interfere with the others. -These modules are placed in a specific order, however, which assumes that the previous module worked. This is due to the uncircumventable nature of a filesystem (i.e. you cannot open a file for reading/writing without being able to create the file, and you can testing reading/writing without being able to open a file) +These modules are placed in a specific order, however, which assumes that the previous module worked. This is due to the uncircumventable nature of a filesystem (i.e. you cannot open a file for reading/writing without being able to create the file, and you can test reading/writing without being able to open a file) NOTE: When all is working properly, the output from each test will start with "OK", and not "ERROR" @@ -17,22 +17,22 @@ It also tests removing files that are not on the drive. TestOpenClose: -This module tests the ability to open and close files, opening nonexistant files, and closing files multiple times. +This module tests the ability to open and close files, opening non-existent files, and closing files multiple times. TestReadWriteLseek: -This module tests reading to a file, writing to a file, and seeking to a specific byte in a file. Once something is written, the read/write pointer is position at the beginning, and the contents are read, and compared to what was written. +This module tests reading to a file, writing to a file, and seeking to a specific byte in a file. Once something is written, the read/write pointer is positioned at the beginning, and the contents are read, and compared to what was written. TestMkRmDirFreeBytes: -This module making and removing different directories, with files in them. It also tests reading and writing to those files. +This module tests making and removing different directories, with files in them. It also tests reading and writing to those files. It also includes three calls to OS_FreeBytes, to test its functionality TestOpenCloseReadDir: -This module tests opening and closing directories, as well as reading though the directories in search of specific files or sub-level directories. +This module tests opening and closing directories, as well as reading through the directories in search of specific files or sub-level directories. TestRename: -This module create 2 directories, with a file in each, writes data to the file, then tries to rename the files and the directories, and then reads the data written to the files back out after the renaming. +This module creates 2 directories, with a file in each, writes data to the file, then tries to rename the files and the directories, and then reads the data written to the files back out after the renaming. diff --git a/src/tests/file-api-test/file-api-test.c b/src/tests/file-api-test/file-api-test.c index 3ca691f09..807a74030 100644 --- a/src/tests/file-api-test/file-api-test.c +++ b/src/tests/file-api-test/file-api-test.c @@ -195,7 +195,7 @@ void TestCreatRemove(void) /*--------------------------------------------------------------------------------------- * Name: TestOpenClose - * This functions tests the basic functionality of OS_open and OS_close. + * This function tests the basic functionality of OS_open and OS_close. ---------------------------------------------------------------------------------------*/ void TestOpenClose(void) { @@ -485,7 +485,7 @@ void TestMkRmDirFreeBytes(void) status = OS_OpenCreate(&fd2, filename2, OS_FILE_FLAG_CREATE | OS_FILE_FLAG_TRUNCATE, OS_READ_WRITE); UtAssert_True(status >= OS_SUCCESS, "status after creat 2 = %d", (int)status); - /* write the propper buffers into each of the files */ + /* write the proper buffers into each of the files */ size = strlen(buffer1); status = OS_write(fd1, buffer1, size); UtAssert_True(status == size, "status after write 1 = %d size = %lu", (int)status, (unsigned long)size); @@ -796,7 +796,7 @@ void TestRename(void) status = OS_OpenCreate(&fd1, filename1, OS_FILE_FLAG_CREATE | OS_FILE_FLAG_TRUNCATE, OS_READ_WRITE); UtAssert_True(status >= OS_SUCCESS, "status after creat 1 = %d", (int)status); - /* write the propper buffes into the file */ + /* write the proper buffers into the file */ size = strlen(buffer1); status = OS_write(fd1, buffer1, size); @@ -904,7 +904,7 @@ void TestStat(void) /*--------------------------------------------------------------------------------------- * Name: TestOpenFileAPI - * This function tests the the misc open File API: + * This function tests the misc open File API: * OS_FileOpenCheck(char *Filename); * OS_CloseAllFiles(void); * OS_CloseFileByName(char *Filename); diff --git a/src/tests/network-api-test/network-api-test.c b/src/tests/network-api-test/network-api-test.c index 9e7c29213..6a9f8e778 100644 --- a/src/tests/network-api-test/network-api-test.c +++ b/src/tests/network-api-test/network-api-test.c @@ -296,7 +296,7 @@ void TestDatagramNetworkApi(void) /* Send data from peer1 to peer2 */ UtAssert_INT32_EQ(OS_SocketSendTo(p1_socket_id, &Buf1, sizeof(Buf1), &p2_addr), sizeof(Buf1)); - /* Recieve data from peer1 to peer2 */ + /* Receive data from peer1 to peer2 */ UtAssert_INT32_EQ(OS_SocketRecvFrom(p2_socket_id, &Buf2, sizeof(Buf2), &l_addr, UT_TIMEOUT), sizeof(Buf2)); UtAssert_True(Buf1 == Buf2, "Buf1 (%ld) == Buf2 (%ld)", (long)Buf1, (long)Buf2); @@ -314,7 +314,7 @@ void TestDatagramNetworkApi(void) /* Send data from peer2 to peer1 */ UtAssert_INT32_EQ(OS_SocketSendTo(p2_socket_id, &Buf3, sizeof(Buf3), &p1_addr), sizeof(Buf3)); - /* Recieve data from peer2 to peer1 */ + /* Receive data from peer2 to peer1 */ UtAssert_INT32_EQ(OS_SocketRecvFrom(p1_socket_id, &Buf4, sizeof(Buf4), &l_addr, UT_TIMEOUT), sizeof(Buf4)); UtAssert_True(Buf3 == Buf4, "Buf3 (%ld) == Buf4 (%ld)", (long)Buf3, (long)Buf4); @@ -382,7 +382,7 @@ void Server_Fn(void) UtPrintf("SERVER: handling connection %u", (unsigned int)iter); - /* Recieve incoming data from client - + /* Receive incoming data from client - * should be exactly 4 bytes on most cycles, but 0 bytes on the cycle * where write shutdown was done by client side prior to initial write. */ if (iter == UT_STREAM_CONNECTION_RDWR_SHUTDOWN) @@ -409,7 +409,7 @@ void Server_Fn(void) { /* Send back to client: * 1. uint32 value indicating number of connections so far (4 bytes) - * 2. Original value recieved above (4 bytes) + * 2. Original value received above (4 bytes) * 3. String of all possible 8-bit chars [0-255] (256 bytes) */ Status = OS_TimedWrite(connsock_id, &iter, sizeof(iter), UT_TIMEOUT); @@ -674,20 +674,20 @@ void TestStreamNetworkApi(void) * work) */ if (iter != UT_STREAM_CONNECTION_READ_SHUTDOWN && iter != UT_STREAM_CONNECTION_RDWR_SHUTDOWN) { - /* Recieve back data from server, first is loop count */ + /* Receive back data from server, first is loop count */ expected = sizeof(loopcnt); actual = OS_TimedRead(c_socket_id, &loopcnt, sizeof(loopcnt), UT_TIMEOUT); UtAssert_True(actual == expected, "OS_TimedRead() (%ld) == %ld", (long)actual, (long)expected); UtAssert_UINT32_EQ(iter, loopcnt); - /* Recieve back data from server, next is original string */ + /* Receive back data from server, next is original string */ expected = sizeof(Buf_rcv_c); actual = OS_TimedRead(c_socket_id, Buf_rcv_c, sizeof(Buf_rcv_c), UT_TIMEOUT); UtAssert_True(actual == expected, "OS_TimedRead() (%ld) == %ld", (long)actual, (long)expected); UtAssert_True(strcmp(Buf_send_c, Buf_rcv_c) == 0, "Buf_rcv_c (%s) == Buf_send_c (%s)", Buf_rcv_c, Buf_send_c); - /* Recieve back data from server, next is 8-bit charset */ + /* Receive back data from server, next is 8-bit charset */ expected = sizeof(Buf_each_char_rcv); actual = OS_TimedRead(c_socket_id, Buf_each_char_rcv, sizeof(Buf_each_char_rcv), UT_TIMEOUT); UtAssert_True(actual == expected, "OS_TimedRead() (%ld) == %ld", (long)actual, (long)expected); diff --git a/src/tests/osal-core-test/README.txt b/src/tests/osal-core-test/README.txt index 79c6a2087..9f4144c1d 100644 --- a/src/tests/osal-core-test/README.txt +++ b/src/tests/osal-core-test/README.txt @@ -1,6 +1,6 @@ Explanation: -This osal-core-test.c file is a test to designed to demonstrate the functionality of the functions of osapi.c in the ../os// directory. The tests are separated into different modules- tasks, queues, binary semaphores, mutexes, and *GetInfo functions. +This osal-core-test.c file is a test designed to demonstrate the functionality of the functions of osapi.c in the ../os// directory. The tests are separated into different modules- tasks, queues, binary semaphores, mutexes, and *GetInfo functions. This separation allows for the modules to be run individually or concurrently. Each module does not affect any of the others. @@ -18,7 +18,7 @@ Tries to get the ID of the tasks by their names. Tries to Delete the tasks created previously. -NOTE: for clairity, the tasks are declared in test1.h +NOTE: for clarity, the tasks are declared in test1.h ************ TestQueues ************* diff --git a/src/tests/osal-core-test/osal-core-test.c b/src/tests/osal-core-test/osal-core-test.c index fddea472e..0c349504e 100644 --- a/src/tests/osal-core-test/osal-core-test.c +++ b/src/tests/osal-core-test/osal-core-test.c @@ -314,7 +314,7 @@ void TestQueues(void) /* * Now that the Queues are created, its time to see if we can find - * the propper ID by the name of the queue; + * the proper ID by the name of the queue; */ status = OS_QueueGetIdByName(&msgq_0, "q 0"); UtAssert_True(status == OS_SUCCESS, "OS_QueueGetIdByName, q 0"); diff --git a/src/tests/queue-test/queue-test.c b/src/tests/queue-test/queue-test.c index a7f1526c4..ea2405453 100644 --- a/src/tests/queue-test/queue-test.c +++ b/src/tests/queue-test/queue-test.c @@ -226,7 +226,7 @@ void QueueMessageSetup(void) UtAssert_True(status == OS_SUCCESS, "Timer 1 set Rc=%d", (int)status); /* - * Put 10 messages onto the que with some time inbetween the later messages + * Put 10 messages onto the que with some time in between the later messages * to make sure the que handles both storing and waiting for messages */ for (i = 0; i < MSGQ_TOTAL; i++) diff --git a/src/tests/sem-speed-test/sem-speed-test.c b/src/tests/sem-speed-test/sem-speed-test.c index fdda695b6..8bde8f9e9 100644 --- a/src/tests/sem-speed-test/sem-speed-test.c +++ b/src/tests/sem-speed-test/sem-speed-test.c @@ -49,7 +49,7 @@ /* * Note the worker priority must be lower than that of * the executive (init) task. Otherwise, the SemRun() - * function may may never get CPU time to stop the test. + * function may never get CPU time to stop the test. */ #define SEMTEST_TASK_PRIORITY 150 diff --git a/src/tests/timer-test/timer-test.c b/src/tests/timer-test/timer-test.c index 2863dafbd..85cc1a833 100644 --- a/src/tests/timer-test/timer-test.c +++ b/src/tests/timer-test/timer-test.c @@ -200,7 +200,7 @@ void TimerTestCheck(void) if (TimerInterval[i] == 0) { /* - * When the Timer Interval is 0, it's a one shot so expect eaxctly 1 tick + * When the Timer Interval is 0, it's a one shot so expect exactly 1 tick */ expected = 1; UtAssert_True(timer_counter[i] == (expected), "Timer %d count = %d", (int)i, (int)(expected)); diff --git a/src/unit-test-coverage/portable/src/coveragetest-bsd-select.c b/src/unit-test-coverage/portable/src/coveragetest-bsd-select.c index abd97645a..6329f80b7 100644 --- a/src/unit-test-coverage/portable/src/coveragetest-bsd-select.c +++ b/src/unit-test-coverage/portable/src/coveragetest-bsd-select.c @@ -82,7 +82,7 @@ void Test_OS_SelectSingle_Impl(void) UtAssert_STUB_COUNT(OCS_clock_gettime, 3); UtAssert_STUB_COUNT(OCS_select, 2); - /* Repeaded select with alternate branches */ + /* Repeated select with alternate branches */ OCS_errno = OCS_EAGAIN; SelectFlags = OS_STREAM_STATE_READABLE | OS_STREAM_STATE_WRITABLE; latertime2.tv_nsec = 300000000; diff --git a/src/unit-test-coverage/portable/src/coveragetest-bsd-sockets.c b/src/unit-test-coverage/portable/src/coveragetest-bsd-sockets.c index bacdab00a..7abcd2bbe 100644 --- a/src/unit-test-coverage/portable/src/coveragetest-bsd-sockets.c +++ b/src/unit-test-coverage/portable/src/coveragetest-bsd-sockets.c @@ -168,7 +168,7 @@ void Test_OS_SocketConnect_Impl(void) addr.ActualLength = sizeof(struct OCS_sockaddr_in); OSAPI_TEST_FUNCTION_RC(OS_SocketConnect_Impl, (&token, &addr, 0), OS_ERR_BAD_ADDRESS); - /* Sucessful connect */ + /* Successful connect */ sa->sa_family = OCS_AF_INET; OSAPI_TEST_FUNCTION_RC(OS_SocketConnect_Impl, (&token, &addr, 0), OS_SUCCESS); @@ -185,7 +185,7 @@ void Test_OS_SocketConnect_Impl(void) UT_SetDeferredRetcode(UT_KEY(OS_SelectSingle_Impl), 1, UT_ERR_UNIQUE); OSAPI_TEST_FUNCTION_RC(OS_SocketConnect_Impl, (&token, &addr, 0), UT_ERR_UNIQUE); - /* Timout error by clearing select flags with hook */ + /* Timeout error by clearing select flags with hook */ selectflags = 0; UT_SetHookFunction(UT_KEY(OS_SelectSingle_Impl), UT_Hook_OS_SelectSingle_Impl, &selectflags); OSAPI_TEST_FUNCTION_RC(OS_SocketConnect_Impl, (&token, &addr, 0), OS_ERROR_TIMEOUT); @@ -325,7 +325,7 @@ void Test_OS_SocketSendTo_Impl(void) /* Set up token */ token.obj_idx = UT_INDEX_0; - /* Bad adderss length */ + /* Bad address length */ sa->sa_family = -1; addr.ActualLength = sizeof(struct OCS_sockaddr_in); OSAPI_TEST_FUNCTION_RC(OS_SocketSendTo_Impl, (&token, buffer, sizeof(buffer), &addr), OS_ERR_BAD_ADDRESS); diff --git a/src/unit-test-coverage/shared/CMakeLists.txt b/src/unit-test-coverage/shared/CMakeLists.txt index 7c51940aa..2aafdde48 100644 --- a/src/unit-test-coverage/shared/CMakeLists.txt +++ b/src/unit-test-coverage/shared/CMakeLists.txt @@ -54,7 +54,7 @@ foreach(MODNAME ${MODULE_LIST}) ) endforeach(MODNAME ${MODULE_LIST}) -# Add extra defintion to force the OS_STATIC_SYMTABLE_SOURCE to the +# Add extra definition to force the OS_STATIC_SYMTABLE_SOURCE to the # local value within the module coverage test target_compile_definitions(utobj_coverage-shared-module PRIVATE "OS_STATIC_SYMTABLE_SOURCE=OS_UT_STATIC_SYMBOL_TABLE" diff --git a/src/unit-test-coverage/shared/adaptors/CMakeLists.txt b/src/unit-test-coverage/shared/adaptors/CMakeLists.txt index 58caa998b..19a620d04 100644 --- a/src/unit-test-coverage/shared/adaptors/CMakeLists.txt +++ b/src/unit-test-coverage/shared/adaptors/CMakeLists.txt @@ -2,7 +2,7 @@ # are otherwise not exposed. This is generally required for any OSAL subsystem # which tracks an internal resource state (i.e. anything with a table). -# NOTE: These source files are compile with OVERRIDES on the headers just like +# NOTE: These source files are compiled with OVERRIDES on the headers just like # the FSW code is compiled. This is how it is able to include internal headers # which otherwise would fail. But that also means that adaptor code cannot call # any library functions, as this would also reach a stub, not the real function. diff --git a/src/unit-test-coverage/shared/src/coveragetest-idmap.c b/src/unit-test-coverage/shared/src/coveragetest-idmap.c index 9659a3d17..c42b4c823 100644 --- a/src/unit-test-coverage/shared/src/coveragetest-idmap.c +++ b/src/unit-test-coverage/shared/src/coveragetest-idmap.c @@ -141,7 +141,7 @@ void Test_OS_LockUnlockGlobal(void) UT_ResetState(UT_KEY(OS_TaskGetId)); /* - * Execute paths where the incorrect patten is followed, + * Execute paths where the incorrect pattern is followed, * such as unlocking from a different task than the lock. * These trigger OS_DEBUG messages, if compiled in. * diff --git a/src/unit-test-coverage/shared/src/os-shared-coveragetest.h b/src/unit-test-coverage/shared/src/os-shared-coveragetest.h index a2efd7eab..0d34de1fa 100644 --- a/src/unit-test-coverage/shared/src/os-shared-coveragetest.h +++ b/src/unit-test-coverage/shared/src/os-shared-coveragetest.h @@ -79,7 +79,7 @@ typedef union #define UT_INDEX_2 OSAL_INDEX_C(2) /* - * Set up an coverage test iterator of the given type. + * Set up a coverage test iterator of the given type. * * The OS_ObjectIdIteratorGetNext() stub routine will be configured * to return the given range of IDs. diff --git a/src/unit-test-coverage/ut-stubs/inc/OCS_vxWorks.h b/src/unit-test-coverage/ut-stubs/inc/OCS_vxWorks.h index fd5e56ae7..59d960cbe 100644 --- a/src/unit-test-coverage/ut-stubs/inc/OCS_vxWorks.h +++ b/src/unit-test-coverage/ut-stubs/inc/OCS_vxWorks.h @@ -66,7 +66,7 @@ typedef long OCS_Vx_usr_arg_t; * without arguments, e.g. "int (*FUNCPTR)()". This is acceptable * by some compilers but generally incompatible with the * "-Wstrict-prototype" gcc warning option. So in this override it - * is defined as a int argument. This means that application code + * is defined as an int argument. This means that application code * may need to cast it at the time of use (which is generally done anyway). */ typedef int (*OCS_FUNCPTR)(int); diff --git a/src/unit-test-coverage/ut-stubs/inc/README.md b/src/unit-test-coverage/ut-stubs/inc/README.md index 720a7bffd..5a8cd1f0b 100644 --- a/src/unit-test-coverage/ut-stubs/inc/README.md +++ b/src/unit-test-coverage/ut-stubs/inc/README.md @@ -1,7 +1,7 @@ ABOUT THE SYSTEM HEADER OVERRIDES ================================= -The "overrides" directory contain replacement versions of many system-provided +The "overrides" directory contains replacement versions of many system-provided header files. All replacement functions and types are identified using an `OCS_` prefix. diff --git a/src/unit-test-coverage/vxworks/adaptors/CMakeLists.txt b/src/unit-test-coverage/vxworks/adaptors/CMakeLists.txt index 459d59373..eb22c05de 100644 --- a/src/unit-test-coverage/vxworks/adaptors/CMakeLists.txt +++ b/src/unit-test-coverage/vxworks/adaptors/CMakeLists.txt @@ -2,7 +2,7 @@ # are otherwise not exposed. This is generally required for any OSAL subsystem # which tracks an internal resource state (i.e. anything with a table). -# NOTE: These source files are compile with OVERRIDES on the headers just like +# NOTE: These source files are compiled with OVERRIDES on the headers just like # the FSW code is compiled. This is how it is able to include internal headers # which otherwise would fail. But that also means that adaptor code cannot call # any library functions, as this would also reach a stub, not the real function. diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-tasks.c b/src/unit-test-coverage/vxworks/src/coveragetest-tasks.c index 8bbfecb78..afd7c3184 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-tasks.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-tasks.c @@ -147,7 +147,7 @@ void Test_OS_TaskDetach_Impl(void) */ OS_object_token_t token; - /* no-op on VxWorks - always returns sucess */ + /* no-op on VxWorks - always returns success */ OSAPI_TEST_FUNCTION_RC(OS_TaskDetach_Impl(&token), OS_SUCCESS); } diff --git a/src/unit-test-coverage/vxworks/src/coveragetest-timebase.c b/src/unit-test-coverage/vxworks/src/coveragetest-timebase.c index 5005224f9..359c61fd7 100644 --- a/src/unit-test-coverage/vxworks/src/coveragetest-timebase.c +++ b/src/unit-test-coverage/vxworks/src/coveragetest-timebase.c @@ -105,7 +105,7 @@ void Test_OS_TimeBaseCreate_Impl(void) OS_object_token_t token = UT_TOKEN_0; /* - * Test paths though the signal number assignment. + * Test paths through the signal number assignment. * * This should be done first as it will assign the "external_sync" * and therefore cause future calls to skip this block. diff --git a/src/unit-tests/osfile-test/ut_osfile_dirio_test.c b/src/unit-tests/osfile-test/ut_osfile_dirio_test.c index b6ed6d5a4..d74c8a132 100644 --- a/src/unit-tests/osfile-test/ut_osfile_dirio_test.c +++ b/src/unit-tests/osfile-test/ut_osfile_dirio_test.c @@ -438,7 +438,7 @@ void UT_os_readdir_test() ** 10) Call OS_readdir() the 3rd time with the directory descriptor pointer returned in #3 ** 11) Expect the returned value to be ** (a) a directory entry pointer __and__ -** (b) a the directory name to be "." +** (b) the directory name to be "." **--------------------------------------------------------------------------------*/ void UT_os_rewinddir_test() { diff --git a/src/unit-tests/osfile-test/ut_osfile_fileio_test.c b/src/unit-tests/osfile-test/ut_osfile_fileio_test.c index 078cec401..8d406454f 100644 --- a/src/unit-tests/osfile-test/ut_osfile_fileio_test.c +++ b/src/unit-tests/osfile-test/ut_osfile_fileio_test.c @@ -1257,7 +1257,7 @@ void UT_os_copyfile_test() ** Syntax: int32 OS_mv(const char *src, const char *dest) ** Purpose: Moves the given file to a new specified file ** Parameters: *src - pointer to the absolute path of the file to be moved -** *dest - pointer to the aboslute path of the new file +** *dest - pointer to the absolute path of the new file ** Returns: OS_INVALID_POINTER if any of the pointers passed in is null ** OS_FS_ERR_INVALID_PATH if path is invalid ** OS_FS_ERR_PATH_TOO_LONG if the path name is too long diff --git a/src/unit-tests/osfilesys-test/ut_osfilesys_diskio_test.c b/src/unit-tests/osfilesys-test/ut_osfilesys_diskio_test.c index f83291b89..a27f55938 100644 --- a/src/unit-tests/osfilesys-test/ut_osfilesys_diskio_test.c +++ b/src/unit-tests/osfilesys-test/ut_osfilesys_diskio_test.c @@ -706,7 +706,7 @@ void UT_os_getfsinfo_test(void) ** (a) OS_FS_ERR_PATH_TOO_LONG ** ----------------------------------------------------- ** Test #3: Invalid-virtual-path-arg condition -** 1) Call this routine with a incorrectly formatted virtual path name as argument +** 1) Call this routine with an incorrectly formatted virtual path name as argument ** 2) Expect the returned value to be ** (a) OS_FS_ERR_PATH_INVALID ** ----------------------------------------------------- @@ -857,7 +857,7 @@ void UT_os_checkfs_test() /*--------------------------------------------------------------------------------* ** Syntax: int32 OS_fsstatvolume(const char *name) -** Purpose: Returns the number of blocks free in a the file system +** Purpose: Returns the number of blocks free in the file system ** Parameters: *name - a pointer to the name of the drive to check for free blocks ** Returns: OS_INVALID_POINTER if the pointer passed in is NULL ** OS_FS_ERR_PATH_TOO_LONG if the path passed in is too long diff --git a/src/unit-tests/osloader-test/ut_osloader_symtable_test.c b/src/unit-tests/osloader-test/ut_osloader_symtable_test.c index 96333b1b2..1a5f8bc88 100644 --- a/src/unit-tests/osloader-test/ut_osloader_symtable_test.c +++ b/src/unit-tests/osloader-test/ut_osloader_symtable_test.c @@ -38,7 +38,7 @@ /** * The size limit to pass for OS_SymbolTableDump nominal test * - * This must be large enough to actually accomodate all of the symbols + * This must be large enough to actually accommodate all of the symbols * in the target system. */ #define UT_SYMTABLE_SIZE_LIMIT 1048576 diff --git a/ut_assert/README.txt b/ut_assert/README.txt index 4fde6aa99..98ba7e275 100644 --- a/ut_assert/README.txt +++ b/ut_assert/README.txt @@ -21,7 +21,7 @@ is true or false. This approach is much different than the Flight Software Branc historical approach to unit testing that creates a log file that requires developer analysis in order to determine whether a test passed or failed. In order to use the tools a developer populates the framework with their unit tests and links with the -ut-asssert library to create an executable. +ut-assert library to create an executable. Project Goals @@ -40,9 +40,9 @@ analysis in order to determine whether a test passed or failed. Functional Goals This approach allows developers to write self-verifying unit tests and the tools -provide a framework that allow unit tests to be bundled into a single executional +provide a framework that allow unit tests to be bundled into single executable units. This aggregation allows comprehensive automated unit testing so as FSRL -components are added and/or modfiied automated regression unit testing can be +components are added and/or modified automated regression unit testing can be performed. Evolvability Goals diff --git a/ut_assert/inc/utassert.h b/ut_assert/inc/utassert.h index bde9ff397..10208dddd 100644 --- a/ut_assert/inc/utassert.h +++ b/ut_assert/inc/utassert.h @@ -24,9 +24,9 @@ * Purpose: This code implements a standard set of asserts for use in unit tests. * * Design Notes: - * - All asserts evaluate a expression as true or false to determine if a unit test has + * - All asserts evaluate an expression as true or false to determine if a unit test has * passed or failed. true means the test passed, false means the test failed. - * - All asserts return a boolen result to indicate the pass fail status. + * - All asserts return a boolean result to indicate the pass fail status. * - All asserts are implemented as macros to hide the __LINE__ and __FILE__ macros. * - All asserts must call the function UtAssert. */ @@ -129,7 +129,7 @@ typedef struct #define UtAssert_Simple(Expression) UtAssert(Expression, #Expression, __FILE__, __LINE__) /** - * \brief Evaluates a expression as either true or false. + * \brief Evaluates an expression as either true or false. * * true means the test passed, false means the test failed. */ @@ -546,7 +546,7 @@ UtAssert_CaseType_t UtAssert_GetContext(void); * * This is the name that was previously set via UtAssert_BeginTest() * - * \note the appliction should not store this pointer, it may become + * \note the application should not store this pointer, it may become * invalid after the next call to UtAssert_EndTest() * * \returns pointer to current segment name @@ -573,7 +573,7 @@ bool UtAssert(bool Expression, const char *Description, const char *File, uint32 /** * \brief Assert function with specific CaseType (supports MIR, TSF, NA in addition to FAIL). * - * This assert routine allows more consise description of the test case, as it supports + * This assert routine allows more concise description of the test case, as it supports * printf-style message strings to allow dynamic content in the messages. * * \param Expression a boolean value which evaluates "true" if the test passes @@ -650,7 +650,7 @@ void UtAssert_DoReport(const char *File, uint32 LineNum, uint32 SegmentNum, uint /** * The BSP overall test reporting function. * - * Invokes the BSP-specific overall pass/fail reporting mechanism based the subsystem pass/fail counters. + * Invokes the BSP-specific overall pass/fail reporting mechanism based on the subsystem pass/fail counters. * * Like the UtAssert_DoReport() function, this is typically done as a message on the console/log however * it might be different for embedded targets. diff --git a/ut_assert/inc/utbsp.h b/ut_assert/inc/utbsp.h index bec41899a..85c88c97a 100644 --- a/ut_assert/inc/utbsp.h +++ b/ut_assert/inc/utbsp.h @@ -89,7 +89,7 @@ void UT_BSP_DoText(uint8 MessageType, const char *OutputMessage); /** * The BSP overall test end function. * - * Invokes the BSP-specific global pass/fail reporting mechanism based the global overall pass/fail counters. + * Invokes the BSP-specific global pass/fail reporting mechanism based on the global overall pass/fail counters. * * This function ends the current test process and returns to the controlling process. * diff --git a/ut_assert/inc/utstubs.h b/ut_assert/inc/utstubs.h index ed593b208..0a214cfa1 100644 --- a/ut_assert/inc/utstubs.h +++ b/ut_assert/inc/utstubs.h @@ -42,7 +42,7 @@ /** * Using a generic memory address as a key into table - * this should allow the function name (with a cast) to be used as the key, - * but allow allows a fancier hash algorithm if needed. + * but allows a fancier hash algorithm if needed. * Note - in pedantic mode using a "void *" here triggers a warning * if used with a function address, but no warning is generated if using * an integer memory address type. diff --git a/ut_assert/scripts/generate_stubs.pl b/ut_assert/scripts/generate_stubs.pl index 9dff1e610..4a0792a24 100755 --- a/ut_assert/scripts/generate_stubs.pl +++ b/ut_assert/scripts/generate_stubs.pl @@ -300,7 +300,7 @@ # Now actually write the output stub source file # NOTE: no need to be too fussy about whitespace and formatting here - # as the output file will be passed to clang-fomat at the end. + # as the output file will be passed to clang-format at the end. open(OUT, ">$stubfile") || die "Cannot open $stubfile for writing"; print OUT $boilerplate . "\n";