-
Notifications
You must be signed in to change notification settings - Fork 253
Description
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-filesys.h, function OS_FileSysAddFixedMap():
- ONLY IN DOXY: OS_ERR_NAME_TOO_LONG
- ONLY IN DOXY: OS_FS_ERR_PATH_TOO_LONG
- ONLY IN DOXY: OS_INVALID_POINTER
File src/os/inc/osapi-filesys.h, function OS_mkfs():
- OK: OS_FS_ERR_DEVICE_NOT_FREE
- ONLY IN DOXY: OS_FS_ERR_DRIVE_NOT_CREATED
- ONLY IN TEST: OS_FS_ERR_PATH_TOO_LONG
- OK: OS_INVALID_POINTER
- OK: OS_SUCCESS
File src/os/inc/osapi-filesys.h, function OS_mount():
- OK: OS_ERR_NAME_NOT_FOUND
- ONLY IN DOXY: OS_FS_ERR_PATH_TOO_LONG
- OK: OS_INVALID_POINTER
- ONLY IN TEST: OS_SUCCESS
File src/os/inc/osapi-filesys.h, function OS_initfs():
- OK: OS_FS_ERR_DEVICE_NOT_FREE
- ONLY IN DOXY: OS_FS_ERR_DRIVE_NOT_CREATED
- OK: OS_FS_ERR_PATH_TOO_LONG
- OK: OS_INVALID_POINTER
- OK: OS_SUCCESS
File src/os/inc/osapi-filesys.h, function OS_rmfs():
- ONLY IN DOXY: OS_ERROR
- OK: OS_ERR_NAME_NOT_FOUND
- ONLY IN DOXY: OS_FS_ERR_PATH_TOO_LONG
- OK: OS_INVALID_POINTER
- ONLY IN DOXY: OS_SUCCESS
File src/os/inc/osapi-filesys.h, function OS_unmount():
- ONLY IN DOXY: OS_ERROR
- OK: OS_ERR_NAME_NOT_FOUND
- OK: OS_FS_ERR_PATH_TOO_LONG
- OK: OS_INVALID_POINTER
- OK: OS_SUCCESS
File src/os/inc/osapi-filesys.h, function OS_FileSysStatVolume():
- ONLY IN DOXY: OS_ERROR
- OK: OS_FS_ERR_PATH_TOO_LONG
- OK: OS_INVALID_POINTER
- OK: OS_SUCCESS
File src/os/inc/osapi-filesys.h, function OS_chkfs():
- ONLY IN DOXY: OS_ERROR
- ONLY IN DOXY: OS_ERR_NOT_IMPLEMENTED
- OK: OS_FS_ERR_PATH_TOO_LONG
- OK: OS_INVALID_POINTER
- ONLY IN DOXY: OS_SUCCESS
File src/os/inc/osapi-filesys.h, function OS_FS_GetPhysDriveName():
- ONLY IN DOXY: OS_ERROR
- OK: OS_ERR_NAME_NOT_FOUND
- OK: OS_FS_ERR_PATH_TOO_LONG
- OK: OS_INVALID_POINTER
- OK: OS_SUCCESS
File src/os/inc/osapi-filesys.h, function OS_TranslatePath():
- ONLY IN DOXY: OS_FS_ERR_NAME_TOO_LONG
- OK: OS_FS_ERR_PATH_INVALID
- OK: OS_FS_ERR_PATH_TOO_LONG
- OK: OS_INVALID_POINTER
- OK: OS_SUCCESS
File src/os/inc/osapi-filesys.h, function OS_GetFsInfo():
- 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.