Integration Candidate: 2020-09-02 #590
Conversation
Update all internal OSAL code to use the typedef when creating, storing, or otherwise dealing with abstract ID values. Removes/fixes any code that directly compares or casts the IDs between normal integer values. Replace equality comparisons with inline functions to check for equality and validity.
Update file-sys-add-fixed-map-api-test and network-api-test to use the osal_id_t typedef and proper conversion/test functions for manipulating object IDs.
Fix #581, Use OS_MAX_TIMEBASES for max timer create unit test
Fix #555, provide typedef for OSAL ID
Fix #537, Fail tests on startup and tear down failures
|
@skliper and @jphickey looks like we have some usersguide doxygen errors at the bundle level |
|
Looks like these are mostly deprecated symbols that are now removed, hence why they've become warnings now. Doxygen must not have known about the "OMIT_DEPRECATED" flag or else these would have shown up earlier. Basically a bug that has existed for a long time but only just showing up now. |
|
@yammajamma - could you resolve these? I suggest updating the links if there is a replacement (any of the scoping name changes or API updates), or removing the reference/update the documentation if the functionality was deprecated. |
Fix some newly triggered warnings with respect to the doxygen markup and references. Also move the definition of OS_file_flags_t (enum type) to the public API to satisfy a reference issue in OS_OpenCreate().
|
@yammajamma can you update the "Expected behavior changes" above with a summary of the hotfixes? |
Fix nasa#590, Clarify the documentation on SB MsgId
Describe the contribution
Fix #555
Fix #537
Fix #581
Testing performed
Bundle CI - https://github.com/nasa/cFS/pull/136/checks
Expected behavior changes
PR #568 - Introduces a new
typedef, osal_id_t, incommon_types.h, which should be used to represent an OSAL ID. All API structures/functions are updated to use this typedef in place of the uint32 type wherever it actually refers to an OSAL ID.PR #579 - Fail tests on startup or tear down failures. These are failures, just a different severity (likely mean the test didn't work as expected and needs to be fixed).
PR #583 - Max timer create test was using
OS_MAX_TIMERS(the limit for adding timers to a time base), but creating timers is limited byOS_MAX_TIMEBASESsince the create adds a new time base.HOTFIX 20200902 - Fix documentation warnings in OSAL.
HOTFIX 20200902 - Hide the call graph on utility functions.
System(s) tested on
Ubuntu - CI
Additional context
nasa/cFS#136
Contributor Info - All information REQUIRED for consideration of pull request
Jacob Hageman, NASA-GSFC
Joseph Hickey, Vantage Systems, Inc.