From b2a2f3f8d63c84f473c3a01c5e2c83761654ecd5 Mon Sep 17 00:00:00 2001 From: armink Date: Fri, 13 May 2016 16:55:31 +0800 Subject: [PATCH 1/2] =?UTF-8?q?1=E3=80=81=E3=80=90=E5=A2=9E=E5=8A=A0?= =?UTF-8?q?=E3=80=91=E6=96=AD=E8=A8=80=E5=BC=80=E5=85=B3=EF=BC=8C=E7=94=A8?= =?UTF-8?q?=E6=88=B7=E5=8F=AF=E4=BB=A5=E9=80=9A=E8=BF=87=E5=85=A8=E5=B1=80?= =?UTF-8?q?=E5=AE=8F=E5=AE=9A=E4=B9=89=E6=89=93=E5=BC=80/=E5=85=B3?= =?UTF-8?q?=E9=97=AD=E6=96=AD=E8=A8=80=E6=A3=80=E6=9F=A5=E5=8A=9F=E8=83=BD?= =?UTF-8?q?=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: armink --- .../components/easylogger/inc/elog_cfg.h | 2 ++ demo/os/linux/easylogger/inc/elog_cfg.h | 2 ++ .../components/easylogger/inc/elog_cfg.h | 2 ++ demo/os/windows/easylogger/inc/elog_cfg.h | 2 ++ docs/zh/port/kernel.md | 16 +++++++++++----- easylogger/inc/elog.h | 6 +++++- easylogger/inc/elog_cfg.h | 2 ++ easylogger/plugins/flash/elog_flash.c | 2 +- 8 files changed, 27 insertions(+), 7 deletions(-) diff --git a/demo/non_os/stm32f10x/components/easylogger/inc/elog_cfg.h b/demo/non_os/stm32f10x/components/easylogger/inc/elog_cfg.h index db485b6..6155e4d 100644 --- a/demo/non_os/stm32f10x/components/easylogger/inc/elog_cfg.h +++ b/demo/non_os/stm32f10x/components/easylogger/inc/elog_cfg.h @@ -33,6 +33,8 @@ #define ELOG_OUTPUT_ENABLE /* setting static output log level */ #define ELOG_OUTPUT_LVL ELOG_LVL_VERBOSE +/* enable assert check */ +#define ELOG_ASSERT_ENABLE /* log buffer size */ #define ELOG_BUF_SIZE 256 /* output line number max length */ diff --git a/demo/os/linux/easylogger/inc/elog_cfg.h b/demo/os/linux/easylogger/inc/elog_cfg.h index 9fa69bf..31c140d 100644 --- a/demo/os/linux/easylogger/inc/elog_cfg.h +++ b/demo/os/linux/easylogger/inc/elog_cfg.h @@ -33,6 +33,8 @@ #define ELOG_OUTPUT_ENABLE /* setting static output log level */ #define ELOG_OUTPUT_LVL ELOG_LVL_VERBOSE +/* enable assert check */ +#define ELOG_ASSERT_ENABLE /* log buffer size */ #define ELOG_BUF_SIZE 512 /* output line number max length */ diff --git a/demo/os/rt-thread/stm32f10x/components/easylogger/inc/elog_cfg.h b/demo/os/rt-thread/stm32f10x/components/easylogger/inc/elog_cfg.h index db485b6..6155e4d 100644 --- a/demo/os/rt-thread/stm32f10x/components/easylogger/inc/elog_cfg.h +++ b/demo/os/rt-thread/stm32f10x/components/easylogger/inc/elog_cfg.h @@ -33,6 +33,8 @@ #define ELOG_OUTPUT_ENABLE /* setting static output log level */ #define ELOG_OUTPUT_LVL ELOG_LVL_VERBOSE +/* enable assert check */ +#define ELOG_ASSERT_ENABLE /* log buffer size */ #define ELOG_BUF_SIZE 256 /* output line number max length */ diff --git a/demo/os/windows/easylogger/inc/elog_cfg.h b/demo/os/windows/easylogger/inc/elog_cfg.h index 9fa69bf..31c140d 100644 --- a/demo/os/windows/easylogger/inc/elog_cfg.h +++ b/demo/os/windows/easylogger/inc/elog_cfg.h @@ -33,6 +33,8 @@ #define ELOG_OUTPUT_ENABLE /* setting static output log level */ #define ELOG_OUTPUT_LVL ELOG_LVL_VERBOSE +/* enable assert check */ +#define ELOG_ASSERT_ENABLE /* log buffer size */ #define ELOG_BUF_SIZE 512 /* output line number max length */ diff --git a/docs/zh/port/kernel.md b/docs/zh/port/kernel.md index f4f5a92..2c0f61c 100644 --- a/docs/zh/port/kernel.md +++ b/docs/zh/port/kernel.md @@ -135,32 +135,38 @@ const char *elog_port_get_t_info(void) #define ELOG_LVL_DEBUG 4 #define ELOG_LVL_VERBOSE 5 ``` +### 4.3 断言开关 -### 4.3 缓冲区大小 +开启后，将会启动断言检查功能。如果关闭，所有断言检查代码都将会被替换为空。 + +- 默认状态：开启 +- 操作方法：开启、关闭`ELOG_ASSERT_ENABLE`宏即可 + +### 4.4 缓冲区大小 缓冲区大小决定了日志一行最多输出多少字符，单位：byte。 - 操作方法：修改`ELOG_BUF_SIZE`宏对应值即可 -### 4.4 行号最大长度 +### 4.5 行号最大长度 建议设置`5`较为合适，用户可以根据自己的文件行号最大值进行设置，例如最大行号为：`9999`，则可以设置行号最大长度为`4` - 操作方法：修改`ELOG_LINE_NUM_MAX_LEN`宏对应值即可 -### 4.5 过滤标签最大长度 +### 4.6 过滤标签最大长度 日志中标签内容及用户设置过滤标签的最大长度，单位：byte。 - 操作方法：修改`ELOG_FILTER_TAG_MAX_LEN`宏对应值即可 -### 4.6 过滤关键词最大长度 +### 4.7 过滤关键词最大长度 用户可设置过滤关键字的最大长度，单位：byte。 - 操作方法：修改`ELOG_FILTER_KW_MAX_LEN`宏对应值即可 -### 4.7 换行符 +### 4.8 换行符 用户可以根据自己的使用场景自定义换行符，例如：`"\r\n"`，`"\n"` diff --git a/easylogger/inc/elog.h b/easylogger/inc/elog.h index 2e03c0a..4d7c74a 100644 --- a/easylogger/inc/elog.h +++ b/easylogger/inc/elog.h @@ -74,9 +74,10 @@ extern "C" { #define ELOG_LVL_TOTAL_NUM 6 /* EasyLogger software version number */ -#define ELOG_SW_VERSION "0.09.16" +#define ELOG_SW_VERSION "1.05.13" /* EasyLogger assert for developer. */ +#ifdef ELOG_ASSERT_ENABLE #define ELOG_ASSERT(EXPR) \ if (!(EXPR)) \ { \ @@ -87,6 +88,9 @@ if (!(EXPR)) \ elog_assert_hook(#EXPR, __FUNCTION__, __LINE__); \ } \ } +#else +#define ELOG_ASSERT(EXPR) ((void)0); +#endif /* all formats index */ typedef enum { diff --git a/easylogger/inc/elog_cfg.h b/easylogger/inc/elog_cfg.h index 9d4d626..98ac758 100644 --- a/easylogger/inc/elog_cfg.h +++ b/easylogger/inc/elog_cfg.h @@ -33,6 +33,8 @@ #define ELOG_OUTPUT_ENABLE /* setting static output log level */ #define ELOG_OUTPUT_LVL /* @note you must define it for a value */ +/* enable assert check */ +#define ELOG_ASSERT_ENABLE /* log buffer size */ #define ELOG_BUF_SIZE /* @note you must define it for a value */ /* output line number max length */ diff --git a/easylogger/plugins/flash/elog_flash.c b/easylogger/plugins/flash/elog_flash.c index e693976..877cf67 100644 --- a/easylogger/plugins/flash/elog_flash.c +++ b/easylogger/plugins/flash/elog_flash.c @@ -66,7 +66,7 @@ ElogErrCode elog_flash_init(void) { ElogErrCode result = ELOG_NO_ERR; /* buffer size must be word alignment */ - ELOG_ASSERT(ELOG_FLASH_BUF_SIZE % 4 == 0) + ELOG_ASSERT(ELOG_FLASH_BUF_SIZE % 4 == 0); #ifdef ELOG_FLASH_USING_BUF_MODE /* initialize current flash log buffer write position */ From 63aae48ac2e6f1ef6e26e190d20962351c3febff Mon Sep 17 00:00:00 2001 From: armink Date: Tue, 2 Aug 2016 10:37:56 +0800 Subject: [PATCH 2/2] =?UTF-8?q?1=E3=80=81=E3=80=90=E6=9B=B4=E6=96=B0?= =?UTF-8?q?=E3=80=91=E8=AF=B4=E6=98=8E=E6=96=87=E6=A1=A3=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: armink --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 588d847..8b53ba1 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ EasyLogger拥有过滤方式、输出格式、输出开关这些属性。 ### 2.2 输出级别 -参考Android Logcat，级别最高为0(Assert)，最小为5(Verbose)。 +参考Android Logcat，级别最高为0(Assert)，最低为5(Verbose)。 ``` 0.[A]：断言(Assert) @@ -57,7 +57,7 @@ EasyLogger拥有过滤方式、输出格式、输出开关这些属性。 ### 2.3 输出过滤 -支持按照**级别、标签及关键词**进行过滤。日志内容较多时，使用过滤功能可以更快定位日志，保证日志的可读性。更多的过滤功能设置方法及细节请阅读[`\docs\zh\api\kernel.md`](https://github.com/armink/EasyLogger/blob/master/docs/zh/api/kernel.md)文档 +支持按照 **级别、标签及关键词** 进行过滤。日志内容较多时，使用过滤功能可以更快定位日志，保证日志的可读性。更多的过滤功能设置方法及细节请阅读[`\docs\zh\api\kernel.md`](https://github.com/armink/EasyLogger/blob/master/docs/zh/api/kernel.md)文档 ### 2.4 输出格式 @@ -82,7 +82,7 @@ EasyLogger拥有过滤方式、输出格式、输出开关这些属性。 - API文档：[`\docs\zh\api\kernel.md`](https://github.com/armink/EasyLogger/blob/master/docs/zh/api/kernel.md) - 移植文档：[`\docs\zh\port\kernel.md`](https://github.com/armink/EasyLogger/blob/master/docs/zh/port/kernel.md) -![easylogger](http://git.oschina.net/Armink/EasyLogger/raw/master/docs/zh/images/EasyLoggerDemo.gif) +![easylogger](https://raw.githubusercontent.com/armink/EasyLogger/master/docs/zh/images/EasyLoggerDemo.gif) ### 2.6.2 Flash Log（将日志保存到Flash中） @@ -92,7 +92,7 @@ EasyLogger拥有过滤方式、输出格式、输出开关这些属性。 - API文档：[`\docs\zh\api\flash.md`](https://github.com/armink/EasyLogger/blob/master/docs/zh/api/flash.md) - 移植文档：[`\docs\zh\port\flash.md`](https://github.com/armink/EasyLogger/blob/master/docs/zh/port/flash.md) -![FlashLog](http://git.oschina.net/Armink/EasyLogger/raw/master/docs/zh/images/LogDemo.gif) +![FlashLog](https://raw.githubusercontent.com/armink/EasyLogger/master/docs/zh/images/LogDemo.gif) # 3. 文档