From 11776a385e58d4b81ea15d26c838b991f485ed2b Mon Sep 17 00:00:00 2001 From: Jacob Hageman Date: Thu, 3 Jun 2021 17:18:00 +0000 Subject: [PATCH] Fix #567, Document CFE_ES_RunLoop increment task counter behavior --- modules/core_api/fsw/inc/cfe_es.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/modules/core_api/fsw/inc/cfe_es.h b/modules/core_api/fsw/inc/cfe_es.h index edaf23745..bb550350b 100644 --- a/modules/core_api/fsw/inc/cfe_es.h +++ b/modules/core_api/fsw/inc/cfe_es.h @@ -355,7 +355,9 @@ void CFE_ES_ExitApp(uint32 ExitStatus); ** the system. ** ** \par Assumptions, External Events, and Notes: -** None +** This API updates the internal task counter tracked by ES for the calling task. +** For ES to report application counters correctly this API should be called +** from the main app task as part of it's main processing loop. ** ** \param[in] RunStatus A pointer to a variable containing the Application's ** desired run status. Acceptable values are: