Fix nasa#1147, Correct code comment typos

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),)

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"
 )

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.
      */

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

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.
 
  ------------------------------------------------------------------*/

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.

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

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
  *

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

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.

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

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

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

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.
  *

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

src/os/portable/os-impl-bsd-sockets.c

@@ -22,7 +22,7 @@
  * \file   os-impl-bsd-sockets.c
  * \author [email protected]
  *
- * 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);

src/os/posix/inc/os-impl-gettime.h

@@ -32,7 +32,7 @@
 #include <time.h>
 
 /**
- * \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().

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 */

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 */

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

src/os/rtems/inc/os-impl-gettime.h

@@ -32,7 +32,7 @@
 #include <time.h>
 
 /**
- * \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().

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;

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;
     }

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;
         }

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.
  */

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);

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 */