Skip to content

Commit

Permalink
Fix #1703, update docs for CFE_FS_BackgroundFileDumpRequest
Browse files Browse the repository at this point in the history
Update notes to better clarify that the meta object must persist
for the duration of the dump operation, which occurs in another task,
so it must not be on the stack.
  • Loading branch information
jphickey committed Jul 23, 2021
1 parent 33a4f19 commit 7c1e39e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions modules/core_api/fsw/inc/cfe_fs.h
Original file line number Diff line number Diff line change
Expand Up @@ -291,8 +291,8 @@ CFE_Status_t CFE_FS_ExtractFilenameFromPath(const char *OriginalPath, char *File
** Puts the previously-initialized metadata into the pending request queue
**
** \par Assumptions, External Events, and Notes:
** Metadata structure should be stored in a static memory area (not on heap) as it
** must persist and be accessible by the file writer task throughout the asynchronous
** Metadata structure should be stored in a persistent memory area (not on stack) as
** it must remain accessible by the file writer task throughout the asynchronous
** job operation.
**
** \param[inout] Meta The background file write persistent state object
Expand Down

0 comments on commit 7c1e39e

Please sign in to comment.