Typo, copy/paste, comment clean-up

[skliper]

Is your feature request related to a problem? Please describe.
General issue to capture typo, copy/paste cleanup from OSAL code review.

Extra space:

osal/src/os/inc/osapi-dir.h

Line 124 in ead5723

* Removes a directory from the structure.

Add comment to justify numbers: common pattern to represent 8 obtjects in a byte (single bit)

osal/src/os/inc/osapi-select.h

Line 41 in ead5723

uint8 object_ids[(OS_MAX_NUM_OPEN_FILES + 7) / 8];

Clarify in comments if OS_TaskDelay is a "busy" wait or scheduled (sleep):

osal/src/os/inc/osapi-task.h

Lines 142 to 154 in ead5723

	/*-------------------------------------------------------------------------------------*/
	/**
	* @brief Delay a task for specified amount of milliseconds
	*
	* Causes the current thread to be suspended from execution for the period of millisecond.
	*
	* @param[in] millisecond Amount of time to delay
	*
	* @return Execution status, see @ref OSReturnCodes
	* @retval #OS_SUCCESS @copybrief OS_SUCCESS
	* @retval #OS_ERROR if sleep fails or millisecond = 0
	*/
	int32 OS_TaskDelay(uint32 millisecond);

Document Input parameter as actually in/out:

osal/src/os/portable/os-impl-bsd-select.c

Lines 112 to 123 in ead5723

	/*----------------------------------------------------------------
	* Function: OS_FdSet_ConvertOut_Impl
	*
	* Purpose: Local helper routine, not part of OSAL API.
	*
	* Convert a POSIX fd_set structure into an OSAL OS_FdSet
	* which can then be returned back to the application.
	*
	* This actually un-sets any bits in the "Input" parameter
	* which are also set in the "output" parameter.
	*-----------------------------------------------------------------*/
	static void OS_FdSet_ConvertOut_Impl(fd_set *output, OS_FdSet *Input)

Make capitalization consistent output -> Output:

osal/src/os/portable/os-impl-bsd-select.c

Line 123 in ead5723

static void OS_FdSet_ConvertOut_Impl(fd_set *output, OS_FdSet *Input)

Clarify comment - Explicitly zero for consistency in operations and to avoid confusion:

osal/src/os/portable/os-impl-bsd-select.c

Line 182 in ead5723

/* eliminates a false warning about possibly uninitialized use */

Clarify comment - Test for existence and is a directory

osal/src/os/portable/os-impl-posix-dirs.c

Lines 85 to 89 in ead5723

	/* it exists, but not necessarily a directory */
	if (stat(local_path, &st) == 0 && S_ISDIR(st.st_mode))
	{
	return_code = OS_SUCCESS;
	}

Duplicate function comments:

osal/src/os/shared/src/osapi-common.c

Lines 258 to 274 in ead5723

	/*---------------------------------------------------------------------------------------
	Name: OS_CleanUpObject
	Purpose: Implements a single API call that can delete ANY object
	Will dispatch to the correct delete implementation for that object type
	Returns: None
	---------------------------------------------------------------------------------------*/
	/*----------------------------------------------------------------
	*
	* Function: OS_CleanUpObject
	*
	* Purpose: Local helper routine, not part of OSAL API.
	*
	*-----------------------------------------------------------------*/

check_mode -> lock_mode:

osal/src/os/shared/src/osapi-idmap.c

Lines 1073 to 1076 in ead5723

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

Comment cleanup, vsnprintf also does the format, Call vsnprintf to format and determine the actual size of the string to write:

osal/src/os/shared/src/osapi-printf.c

Lines 284 to 289 in ead5723

	/*
	* Call vsnprintf() to determine the actual size of the
	* string we are going to write to the buffer after formatting.
	*/
	va_start(va, String);
	actualsz = vsnprintf(msg_buffer, sizeof(msg_buffer), String, va);

data_size -> max_size:

osal/src/os/shared/src/osapi-queue.c

Line 90 in ead5723

int32 OS_QueueCreate(osal_id_t *queue_id, const char *queue_name, osal_blockcount_t queue_depth, size_t data_size,

Clarify constants in comments:

osal/src/os/shared/src/osapi-select.c

Line 144 in ead5723

Set->object_ids[local_id >> 3] |= 1 << (local_id & 0x7);

osal/src/os/shared/src/osapi-select.c

Line 169 in ead5723

Set->object_ids[local_id >> 3] &= ~(1 << (local_id & 0x7));

osal/src/os/shared/src/osapi-select.c

Line 197 in ead5723

return ((Set->object_ids[local_id >> 3] >> (local_id & 0x7)) & 0x1);

Justify constant return - Return OK since called from taskSpawn (where it's not easily accessible), error is reported in debug message:

osal/src/os/vxworks/src/os-impl-console.c

Line 122 in ead5723

return OK;

Clarify - locally scoped statically allocated buffer:

osal/src/os/vxworks/src/os-impl-tasks.c

Line 169 in ead5723

* could be replaced with a statically-allocated OSAL stack buffer.

Justify constants (+500/1000) rounds:

osal/src/os/vxworks/src/os-impl-timebase.c

Line 325 in ead5723

OS_SharedGlobalVars.MicroSecPerTick = (OS_ClockAccuracyNsec + 500) / 1000;

Describe the solution you'd like
Fix

Describe alternatives you've considered
None

Additional context
No impacts

Requester Info
Jacob Hageman - NASA/GSFC, OSAL code review