-
Notifications
You must be signed in to change notification settings - Fork 236
Description
Is your feature request related to a problem? Please describe.
Various cleanup:
-
Document
OUTPUT_DIRECTORYingenerate_config_includefileparameter list: cFS-Caelum Review, CFS-40: ES, Resource ID, core api and private, and build system #1283 (comment)
cFE/cmake/global_functions.cmake
Lines 67 to 72 in e80aae9
# This function now accepts named parameters: # FILE_NAME - the name of the file to write # FALLBACK_FILE - if no files are found in "defs" using the name match, this file will be used instead. # MATCH_SUFFIX - the suffix to match in the "defs" directory (optional) # PREFIXES - a list of prefixes to match in the "defs" directory (optional) # -
Update parameter list in
read_targetconfig: cFS-Caelum Review, CFS-40: ES, Resource ID, core api and private, and build system #1283 (comment)
cFE/cmake/global_functions.cmake
Lines 134 to 144 in e80aae9
# TGTSYS_LIST: list of CPU architectures used in the build. Note this # will always contain a "native" target (for tools at least) which # is forced to be last. # MISSION_APPS: full list of applications specified in the whole mission # SYSID_<arch>: set for each entry of TGTSYS_LIST, and indicates the # toolchain specified in the target file for that CPU arch. # TGTSYS_<arch>: set to a list of CPU numbers that utilize the same arch # TGTSYS_<arch>_APPS: set for each entry of TGTSYS_LIST, and indicates the # full set of applications that need to built for that target architecture # TGTSYS_<arch>_DRIVERS: set for each entry of TGTSYS_LIST, and indicates the # full set of device drivers that need to built for that target architecture -
Add NULL termination documentation on config lists (autogenerated and added via build system):
cFE/cmake/target/src/target_config.c
Line 74 in e80aae9
* A list of modules which are statically linked into CFE core. -
Fix order of parameter documentation for
CFE_ES_WaitForSystemState:
cFE/modules/core_api/fsw/inc/cfe_es.h
Lines 390 to 396 in e80aae9
** \param[in] TimeOutMilliseconds The timeout value in Milliseconds. ** This parameter must be at least 1000. Lower values ** will be rounded up. There is not an option to ** wait indefinitely to avoid hanging a critical ** application because a non-critical app did not start. ** ** \param[in] MinSystemState Determine the state of the App -
Remove OBE child priority comment in
CFE_ES_CreateChildTask, related to Update cFE Application Developers Guide (2 comments) #1033:
cFE/modules/core_api/fsw/inc/cfe_es.h
Lines 797 to 798 in e80aae9
** the highest priority. Applications cannot create tasks with a higher priority ** (lower number) than their own priority. -
Improve generic counter documentation (example, purpose), really just a thread-safe counter capability (suggested at one point for CFDP throttling):
cFE/modules/core_api/fsw/inc/cfe_es.h
Line 1469 in e80aae9
** This routine registers a generic counter. -
Fix typos:
cFE/modules/es/fsw/src/cfe_es_api.c
Line 663 in e80aae9
* in case the does not check the return code.
cFE/modules/es/fsw/src/cfe_es_api.c
Line 700 in e80aae9
* in case the does not check the return code.
cFE/modules/es/fsw/src/cfe_es_api.c
Line 1943 in e80aae9
* in case the does not check the return code.
cFE/modules/es/fsw/src/cfe_es_apps.h
Line 192 in e80aae9
** Internal function start applications based on the startup script -
Add comment that NULL check is done by CFE_ES_GetAppInfo/CFE_ES_GetLibInfo:
cFE/modules/es/fsw/src/cfe_es_api.c
Lines 1080 to 1084 in e80aae9
int32 CFE_ES_GetModuleInfo(CFE_ES_AppInfo_t *ModuleInfo, CFE_ResourceId_t ResourceId) { int32 Status; switch (CFE_ResourceId_GetBase(ResourceId)) -
Document load library calls library entry function in ES context (must not halt, etc)
-
Remove obsolete comments:
cFE/modules/es/fsw/src/cfe_es_erlog.c
Lines 254 to 257 in e80aae9
* It does NOT run in the context of the CFE_TBL app task. * * Events should use CFE_EVS_SendEventWithAppID() rather than CFE_EVS_SendEvent() * to get proper association with TBL task. -
Replace obsolete comments, generically "for initializing and starting cfe"
cFE/modules/es/fsw/src/cfe_es_objtab.c
Line 26 in e80aae9
** This file contains the OS_object_table for MAP Build1. -
s/read/printed/
cFE/modules/es/fsw/src/cfe_es_start.c
Line 99 in e80aae9
** Delay to allow the message to be read
Describe the solution you'd like
Fix
Describe alternatives you've considered
None
Additional context
From CFS-40 and #1283 code review
Requester Info
Jacob Hageman - NASA/GSFC