修改restool README.md说明

Signed-off-by: sunjie <sunjie69@huawei.com>
Change-Id: I376ed49f61771ed1dffcc3aa2f802c587f3dcfba
Signed-off-by: sunjie <sunjie69@huawei.com>
This commit is contained in:
sunjie
2025-01-14 20:21:51 +08:00
parent dff6a6c572
commit f6e5f3fc5d
+30 -2
View File
@@ -25,7 +25,7 @@ restool(资源编译工具)是一种资源构建工具。通过编译资源
### 参数说明
restool当前支持以下命令选项:
#### restool当前支持以下命令选项:
| 选项 | 是否可缺省 | 是否存在入参 | 描述 |
| -------- | -------- | -------- | -------- |
@@ -46,7 +46,7 @@ restool当前支持以下命令选项:
| --defined-ids | 可缺省 | 带参数 | 指定id_defined.json文件路径,一般都是通过--ids生成。<br>id_defined.json包含资源类型、名称及其ID的列表。<br>开发者可以自定义id_defined.json中的资源ID。 |
| --dependEntry | 可缺省 | 带参数 | FA模型下单独编译feature时,指定entry模块的编译结果目录。 |
| --icon-check | 可缺省 | 不带参数 | 开启icon和startWindowIcon的PNG图片校验功能。 |
| --target-config | 可缺省 | 带参数 | 与“-i”命令同时使用,支持选择编译。<br>[参数说明](#target-config参数说明):指定要包含的配置。|
| --target-config | 可缺省 | 带参数 | 与“-i”命令同时使用,支持选择编译。<br>具体可参考如下[参数说明](#target-config参数说明)|
#### target-config参数说明
@@ -66,6 +66,34 @@ Locale匹配规则:Locale匹配需满足以下三条规则。
参数举例说明:Locale[zh_CN,en_US];Device[phone],该参数过滤其他语言,保留能匹配上zh_CN和en_US的语言;过滤其他设备,保留phone;其他参数(如MccMnc、Orientation等)配置不过滤均保留。
#### restool当前支持以下子命令:
| 命令 | 描述 |
| --- | ---- |
| dump | 以json的格式输出hap包中resource的内容 |
**dump命令**
```
restool dump [-h] [config] filePath
```
dump命令参数列表
| 参数 | 是否可缺省 | 是否存在入参 | 参数说明 |
| --- | --------- | ---------- |------- |
| -h | 可缺省 | 不带参数 | 帮助信息 |
| config | 可缺省 | 不带参数 | 只打印hap包中资源的限定词信息 |
示例:
```sh
# 打印hap包中所有的资源信息
restool dump entry.hap
# 打印hap包中资源的限定词信息
restool dump config entry.hap
```
### 使用实例
例如:entry目录结构如下