You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
The unit tests and API documentation should match, where all status codes in the API documentation are tested in a unit test, and likewise all codes being tested for are documented in the API.
Describe the solution you'd like
Resolve the following mismatches:
File src/os/inc/osapi-countsem.h, function OS_CountSemCreate():
ONLY IN TEST: OS_ERROR
OK: OS_ERR_NAME_TAKEN
OK: OS_ERR_NAME_TOO_LONG
OK: OS_ERR_NO_FREE_IDS
OK: OS_INVALID_POINTER
ONLY IN DOXY: OS_INVALID_SEM_VALUE
ONLY IN DOXY: OS_SEM_FAILURE
OK: OS_SUCCESS
File src/os/inc/osapi-countsem.h, function OS_CountSemGive():
OK: OS_ERR_INVALID_ID
ONLY IN DOXY: OS_SEM_FAILURE
OK: OS_SUCCESS
File src/os/inc/osapi-countsem.h, function OS_CountSemTake():
OK: OS_ERR_INVALID_ID
ONLY IN DOXY: OS_SEM_FAILURE
OK: OS_SUCCESS
File src/os/inc/osapi-countsem.h, function OS_CountSemTimedWait():
OK: OS_ERR_INVALID_ID
ONLY IN DOXY: OS_SEM_FAILURE
OK: OS_SEM_TIMEOUT
OK: OS_SUCCESS
File src/os/inc/osapi-countsem.h, function OS_CountSemDelete():
OK: OS_ERR_INVALID_ID
ONLY IN DOXY: OS_SEM_FAILURE
OK: OS_SUCCESS
File src/os/inc/osapi-countsem.h, function OS_CountSemGetIdByName():
OK: OS_ERR_NAME_NOT_FOUND
OK: OS_ERR_NAME_TOO_LONG
OK: OS_INVALID_POINTER
OK: OS_SUCCESS
File src/os/inc/osapi-countsem.h, function OS_CountSemGetInfo():
OK: OS_ERR_INVALID_ID
OK: OS_INVALID_POINTER
OK: OS_SUCCESS
Additional context
Originally noted in #331, split into separate work items.
Requester Info
Joseph Hickey, Vantage Systems, Inc.
The text was updated successfully, but these errors were encountered:
Is your feature request related to a problem? Please describe.
The unit tests and API documentation should match, where all status codes in the API documentation are tested in a unit test, and likewise all codes being tested for are documented in the API.
Describe the solution you'd like
Resolve the following mismatches:
File
src/os/inc/osapi-countsem.h
, functionOS_CountSemCreate()
:File
src/os/inc/osapi-countsem.h
, functionOS_CountSemGive()
:File
src/os/inc/osapi-countsem.h
, functionOS_CountSemTake()
:File
src/os/inc/osapi-countsem.h
, functionOS_CountSemTimedWait()
:File
src/os/inc/osapi-countsem.h
, functionOS_CountSemDelete()
:File
src/os/inc/osapi-countsem.h
, functionOS_CountSemGetIdByName()
:File
src/os/inc/osapi-countsem.h
, functionOS_CountSemGetInfo()
:Additional context
Originally noted in #331, split into separate work items.
Requester Info
Joseph Hickey, Vantage Systems, Inc.
The text was updated successfully, but these errors were encountered: