Update readme_zh and README.OpenSource

issue:I7BAUJ
Signed-off-by: leixin <leixin19@huawei.com>
This commit is contained in:
leixin 2023-06-07 16:38:12 +08:00
parent 8a849c834c
commit d38bd5a7ad
2 changed files with 45 additions and 4 deletions

View File

@ -2,12 +2,10 @@
{
"Name": "libedit",
"License": "BSD-3-Clause",
"License File": "COPYING"
"License File": "COPYING",
"Version Number": "3.1",
"Owner": "leixin19@huawei.com",
"Upstream URL": "http://www.thrysoee.dk/editline/",
"Description": "Libedit is the automatic tool and libtoolized port of the NetBSD Editline library.
It provides generic line editing, history, and markup functions similar to
those in GNU Readline."
"Description": "Libedit is the automatic tool and libtoolized port of the NetBSD Editline library.It provides generic line editing, history, and markup functions similar to those in GNU Readline."
}
]

43
README_zh.md Normal file
View File

@ -0,0 +1,43 @@
# libedit<a name="ZH-CN_TOPIC_0000001106844024"></a>
- [简介](#section11660541593)
- [目录结构](#section367519246426)
- [编译构建](#section137768191623)
- [许可证](#section126611612164217)
## 简介<a name="section11660541593"></a>
libedit是一个提供通用行编辑、历史和分词功能的命令行编辑库类似于Readline。它是NetBSD Editline库的一个自动化工具和libtool化的移植版本它的主要接口和功能包括
- readine(): 从标准输入读取一行,并返回一个指向动态分配缓冲区的指针,该缓冲区包含输入行。
- parse_and_bind(): 执行给定字符串中初始化命令,可以用来设置键绑定和其他选项。
- read_init_file(): 执行一个readline初始化文件可以用来自定义readline的行为。
- get_line_buffer() 返回当前行缓冲区的内容。
- insert_text(): 在光标位置插入文本到行缓冲区。
- redisplay(): 更新屏幕上显示的内容,以反映行缓冲区的当前内容。
在Openharonmy引入后在lldb构建中开启编译可选依赖选项LLDB_ENABLE_LIBEDITlldb.so会依赖libedit编译生成的动态库libedit.so支持lldb调试器在命令行调试时使用libedit库支持自动补齐和gui功能。
## 目录结构<a name="section367519246426"></a>
```
- COPYING 版权文件
- OAT.xml OAT.xml过滤配置文件
- README.OpenSource 项目README.OpenSource文件
- README.md 英文说明
- README_zh.md 中文说明
- libedit-20210910-3.1.tar.gz libedit源码压缩tar包
- libedit.spec 上游更新记录说明
- libedit.yaml yaml文件
```
## 编译与安装<a name="section137768191623"></a>
```
- ./configure用于配置软件的脚本会根据系统环境检测和设置一些变量生成对应的Makefile和一些头文件。其中运行configure脚本的时候指定一些参数来改变配置选项如--prefix指定安装目录--libdir指定库文件目录--bindir指定可执行文件目录。
- make: 用于安装libedit软件根据Makefile中的规则执行一系列的操作编译源代码运行测试检查外部依赖等。
- make install: 将编译好的libedit.so文件安装到配置时指定的目录中。
```
## libedit使用文档
官方文档 https://www.thrysoee.dk/editline/
## 许可证<a name="section126611612164217"></a>
本项目遵从BSD-3-Clause许可证。