如何高效的配置manifest.yml

[xuhaijun]

manifest.yml说明

manifest.yml承载openubmc全量的构建策略，为开发者提供一个直观、灵活的配置界面

设计目标

1. 解耦产品配置与业务实现
2. 提升构建框架扩展性
3. 规范可描述(schema配置)

为何使用yaml

1. 语法简单
2. 可以注释，开发者可以添加说明
3. 可以使用插件校验配置正确性

配置文件要求

1. 严格遵循一板一配置，高度定制化
2. 命名均为manifest.yml，不支持自定义文件名
3. 单板产品自管理，互不干涉，互不影响
4. 配置路径示例(相对于manifest仓根目录)：build/product/BMC/openUBMC/manifest.yml

如果将manifest.yml当成普通的文本将难以理解

使用yaml插件提高配置效率

插件说明

1. 插件可以依据json schema规范来检查yaml文件
2. 在配置外的字段或缺失字段会提示错误
3. 必要的字段可以自动补全
4. 配置的内容可以可以预览

安装方法

在vscode应用市场搜索redhat.vscode-yaml，点击安装即可。

插件功能

安装的yaml插件会在打开manifest.yml文件后，可以提供如下功能：

1. 自动补全：配置项自动补全。
2. 格式提醒：配置错误时以红色波浪线提醒开发者，可以鼠标滑上去查看错误说明。
3. 解释说明：预览每个配置项字段的详细说明、格式约束。