mirror of
https://github.com/armink/EasyLogger.git
synced 2025-01-31 21:42:53 +08:00
1、【完善】文档说明,增加介绍日志颜色功能的使用及配置说明。
Signed-off-by: armink <armink.ztl@gmail.com>
This commit is contained in:
parent
68d4dd7b96
commit
ef95e117f7
@ -14,6 +14,7 @@
|
||||
- 支持多种操作系统([RT-Thread](http://www.rt-thread.org/)、UCOS、Linux、Windows...),也支持裸机平台;
|
||||
- 日志支持 **RAW格式** ;
|
||||
- 支持按 **标签** 、 **级别** 、 **关键词** 进行动态过滤;
|
||||
- 各级别日志支持不同颜色显示
|
||||
- 扩展性强,支持以插件形式扩展新功能。
|
||||
|
||||
> 名词解释:
|
||||
@ -55,6 +56,12 @@ EasyLogger拥有过滤方式、输出格式、输出开关这些属性。
|
||||
5.[V]:详细(Verbose)
|
||||
```
|
||||
|
||||
#### 2.2.1 设置不同的颜色及字体风格
|
||||
|
||||
各个级别日志默认颜色效果如下。用户也可以根据自己的喜好,在 `elog_cfg.h` 对各个级别日志的颜色及字体风格进行单独设置。
|
||||
|
||||
![TextColor](https://raw.githubusercontent.com/armink/EasyLogger/master/docs/zh/images/TextColor.png)
|
||||
|
||||
### 2.3 输出过滤
|
||||
|
||||
支持按照 **级别、标签及关键词** 进行过滤。日志内容较多时,使用过滤功能可以更快定位日志,保证日志的可读性。更多的过滤功能设置方法及细节请阅读[`\docs\zh\api\kernel.md`](https://github.com/armink/EasyLogger/blob/master/docs/zh/api/kernel.md)文档
|
||||
|
@ -245,6 +245,18 @@ void elog_assert_set_hook(void (*hook)(const char* expr, const char* func, size_
|
||||
|:----- |:----|
|
||||
|hook |断言钩子方法|
|
||||
|
||||
### 1.15 使能/失能日志颜色
|
||||
|
||||
日志颜色功能是将各个级别日志按照颜色进行区分,默认颜色功能是关闭的。日志的颜色修改方法详见《EasyLogger 移植说明》中的 `设置参数` 章节。
|
||||
|
||||
```
|
||||
void elog_set_text_color_enabled(bool enabled)
|
||||
```
|
||||
|
||||
|参数 |描述|
|
||||
|:----- |:----|
|
||||
|enabled |true: 使能,false: 失能|
|
||||
|
||||
## 2、配置
|
||||
|
||||
参照EasyLogger 移植说明([`\docs\zh\port\kernel.md`](https://github.com/armink/EasyLogger/blob/master/docs/zh/port/kernel.md))中的 `设置参数` 章节
|
||||
参照 《EasyLogger 移植说明》([`\docs\zh\port\kernel.md`](https://github.com/armink/EasyLogger/blob/master/docs/zh/port/kernel.md))中的 `设置参数` 章节
|
||||
|
BIN
docs/zh/images/TextColor.png
Normal file
BIN
docs/zh/images/TextColor.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 28 KiB |
@ -172,6 +172,20 @@ const char *elog_port_get_t_info(void)
|
||||
|
||||
- 操作方法:修改`ELOG_NEWLINE_SIGN`宏对应值即可
|
||||
|
||||
### 4.9 颜色
|
||||
|
||||
每个级别的日志均有默认颜色。如果想修改,请先查看在 `elog.c` 的头部定义的各种颜色及字体风格,这里以修改 `VERBOSE` 级别日志来举例:
|
||||
|
||||
首先选择前景色为白色,再选择背景色为黑色,最后字体风格为粗体
|
||||
|
||||
那么最终的配置如下:
|
||||
|
||||
```
|
||||
#define ELOG_COLOR_VERBOSE (F_WHITE B_BLACK S_BOLD)
|
||||
```
|
||||
|
||||
- 操作方法:增加并修改`ELOG_COLOR_VERBOSE`宏对应值即可,其他级别日志颜色的修改以此类推
|
||||
|
||||
## 5、测试验证
|
||||
|
||||
如果`\demo\`文件夹下有与项目平台一致的Demo,则直接编译运行,观察测试结果即可。无需关注下面的步骤。
|
||||
|
Loading…
x
Reference in New Issue
Block a user