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 EVS/FS review (and #1294) #1391

Closed
skliper opened this issue Apr 20, 2021 · 0 comments · Fixed by #1576 or #1584
Closed

Comments/document cleanup relative to EVS/FS review (and #1294) #1391

skliper opened this issue Apr 20, 2021 · 0 comments · Fixed by #1576 or #1584
Labels
cFE-FS CFS-41 docs This change only affects documentation.
Milestone

Comments

@skliper
Copy link
Contributor

skliper commented Apr 20, 2021

Is your feature request related to a problem? Please describe.
CFE_FS_ReadHeader parameter descriptions out of order:

** \param[in] FileDes File Descriptor obtained from a previous call to #OS_OpenCreate
** that is associated with the file whose header is to be read.
**
** \param[in, out] Hdr Pointer to a variable of type #CFE_FS_Header_t that will be
** filled with the contents of the Standard cFE File Header. *Hdr is the contents of the
** Standard cFE File Header for the specified file.
**
** \return Execution status, see \ref CFEReturnCodes
**
** \sa #CFE_FS_WriteHeader
**
******************************************************************************/
CFE_Status_t CFE_FS_ReadHeader(CFE_FS_Header_t *Hdr, osal_id_t FileDes);

"primary header" not clear in CFE_FS_Header_t description, really it's the size of this header so tools can be agnostic:

uint32 Length; /**< \brief Length of primary header */

s/Kog/Log/:

uint16 LogCount; /**< \brief Local Event Kog counter */

Typo, but could also just simplify: Get null terminated name for reporting, example below but in 10 copy/paste locations:

* Althgouh EVS_GetApplicationInfo() does not require a null terminated argument,

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 this to the 7.0.0 milestone Apr 20, 2021
@skliper skliper added docs This change only affects documentation. and removed enhancement labels Apr 29, 2021
skliper added a commit to skliper/cFE that referenced this issue May 25, 2021
astrogeco added a commit that referenced this issue May 27, 2021
@skliper skliper removed the EVS label Sep 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cFE-FS CFS-41 docs This change only affects documentation.
Projects
None yet
2 participants