From 031e7e596c0d34ff5e7b9da2d430679b3013cc91 Mon Sep 17 00:00:00 2001 From: Darian Biastoch Date: Fri, 6 Aug 2021 14:37:49 +0200 Subject: 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 --- include/dlt/dlt_common.h | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) 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); -- cgit v1.2.1