summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDarian Biastoch <dbiastoch@de.adit-jv.com>2021-08-06 14:37:49 +0200
committerSaya Sugiura <39760799+ssugiura@users.noreply.github.com>2021-10-05 11:19:26 +0900
commit031e7e596c0d34ff5e7b9da2d430679b3013cc91 (patch)
tree60b0777aed48f321d6bcfa4c53f58c4ec16eb081
parent2b0e0b95fb6a3a5e5a6e104db652a01d9707a3db (diff)
downloadDLT-daemon-031e7e596c0d34ff5e7b9da2d430679b3013cc91.tar.gz
dlt_common: improve function description
The describtion of dlt_init_common was pretty meaningless, that's why an additional sentence and a list of all parsed evironment variables was added. Signed-off-by: Darian Biastoch <dbiastoch@de.adit-jv.com>
-rw-r--r--include/dlt/dlt_common.h12
1 files changed, 11 insertions, 1 deletions
diff --git a/include/dlt/dlt_common.h b/include/dlt/dlt_common.h
index f89cb1b..9a99fce 100644
--- a/include/dlt/dlt_common.h
+++ b/include/dlt/dlt_common.h
@@ -1506,7 +1506,17 @@ void dlt_get_minor_version(char *buf, size_t size);
/* */
/**
- * Common part of initialisation
+ * Common part of initialisation. Evaluates the following environment variables
+ * and stores them in dlt_user struct:
+ * - DLT_DISABLE_EXTENDED_HEADER_FOR_NONVERBOSE
+ * - DLT_LOCAL_PRINT_MODE (AUTOMATIC: 0, FORCE_ON: 2, FORCE_OFF: 3)
+ * - DLT_INITIAL_LOG_LEVEL (e.g. APPx:CTXa:6;APPx:CTXb:5)
+ * - DLT_FORCE_BLOCKING
+ * - DLT_USER_BUFFER_MIN
+ * - DLT_USER_BUFFER_MAX
+ * - DLT_USER_BUFFER_STEP
+ * - DLT_LOG_MSG_BUF_LEN
+ * - DLT_DISABLE_INJECTION_MSG_AT_USER
* @return negative value if there was an error
*/
DltReturnValue dlt_init_common(void);