Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Comments/document cleanup relative to TBL/TIME review #1494

Closed
skliper opened this issue May 11, 2021 · 0 comments · Fixed by #1560 or #1584
Closed

Comments/document cleanup relative to TBL/TIME review #1494

skliper opened this issue May 11, 2021 · 0 comments · Fixed by #1560 or #1584
Assignees
Labels
cFE-TBL Table services cFE-TIME CFS-43 docs This change only affects documentation.
Milestone

Comments

@skliper
Copy link
Contributor

skliper commented May 11, 2021

Is your feature request related to a problem? Please describe.
CFE_TBL_Update, CFE_TBL_Validate, and CFE_TBL_DumpToBuffer are all performed by CFE_TBL_Manage if there's a pending request. Clarify in API documentation for all 4 (missing completely from CFE_TBL_DumpToBuffer).

s/Addresses/Address, this should cross reference, not self reference:

** call this function or #CFE_TBL_GetAddresses.

Add short description of spacecraft time, it's number of seconds since the epoch as set in mission configuration

** This routine returns the current spacecraft time. The time returned

Self reference doesn't make sense:

** or #CFE_MISSION_TIME_CFG_DEFAULT_UTC as true at compile time. To maintain re-usability
** across missions, most applications should be using this function
** (or #CFE_TIME_GetTime) rather than the specific routines for getting UTC/TAI directly.

There is no API to set or adjust leap seconds or SCTF, this should be done by ground command only:

** Applications cannot set or adjust the STCF; that can only be done
** through ground commands. However, science applications may want to

** and universal coordinated time (UTC). Applications cannot set or
** adjust the leap seconds; that can only be done through ground commands.

Now called by a timer, not PSP:

** \brief This function should be called from the system PSP layer once per second

HK command handler also sends the table registry packet (if requested) and dumps "dump-only tables" that are pending, document:

** \par Description
** Constructs a Housekeeping Packet (#CFE_TBL_HousekeepingTlm_t) from task data and sends it out

s/issued/issues:

* This is because TBL services issued a different event ID in some cases if

Remove commented out verification check using sizeof from cfe_tbl_verify.h:

/* the following check is removed because some compilers cannot handle the sizeof operator in a #if statement */
/*
#if sizeof(CFE_PLATFORM_TBL_DEFAULT_REG_DUMP_FILE) > OS_MAX_PATH_LEN
#error The length (including NULL terminator) of CFE_PLATFORM_TBL_DEFAULT_REG_DUMP_FILE cannot be greater than
OS_MAX_PATH_LEN #endif
*/

Remove pointless comment:

/*
** It is possible to call this func with static time value...
*/

Describe the solution you'd like
Fix

Describe alternatives you've considered
None

Additional context
Code review

Requester Info
Jacob Hageman - NASA/GSFC

@skliper skliper added docs This change only affects documentation. CFS-43 labels May 11, 2021
@skliper skliper added this to the 7.0.0 milestone May 11, 2021
@skliper skliper self-assigned this May 20, 2021
skliper added a commit to skliper/cFE that referenced this issue May 20, 2021
astrogeco added a commit that referenced this issue May 27, 2021
@astrogeco astrogeco added cFE-TIME cFE-TBL Table services labels May 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cFE-TBL Table services cFE-TIME CFS-43 docs This change only affects documentation.
Projects
None yet
2 participants