组件管理规范
Revision v0.1
组件组成
每个组件目录下必须有package.yaml和README.md文件。
组件命名
所有组件名字不可重复,名字规范为C语言变量的命名规则,不可超过64字节长度。原则上都采用小写。
Chip组件
- drivers
- include
- sys
- package.yaml
- README.md 命名规则 chip_xxxx (xxxx为芯片名字/型号), 位于components下
drv组件
- include
- src
- package.yaml
- README.md 命名规则 drv_[xxxx]_yyyy (xxxx为IP名字,比如wifi, yyyy为芯片名字/型号), 位于components下
board组件
- configs
- include
- src
- package.yaml
- README.md 命名规则 xxxx_evb(xxxx为芯片名字/型号), 位于board下
solution组件
- app
- Makefile
- SConstruct
- package.yaml
- README.md 命名规则一般能指明这是个solution即可;如果是demo,那么一般命名为xxx_demo,比如wifi_demo., 位于solutions下
Common组件
- include
- src
- package.yaml
- README.md 命名规则:唯一, , 位于components下
README.md 规范
Contents
介绍组件的目录内容,以树状结构列出。
Introduction
简要介绍组件的主要功能。
Features
介绍组件的一些特性
Dependencies
介绍使用组件时所依赖的其它组件
API
介绍组件可对外调用API
Reference
附上组件相关的文档链接
组件提交
- 新增组件
向平头哥仓库管理员@书塔(林书塔)(shuta.lst@alibaba-inc.com)申请平头哥组下的新仓库,需提交组件名字,管理者,组件功能简要描述信息,一般情况下,组件管理员会写两个,组件提供方一个和平头哥一个。
- 更新common组件
- 只是修改配置,无组件代码更新
- 可将配置写到board组件的package.yaml或者是solution下package.yaml文件,该组件无需更新
- 更改组件公共代码
- 组件管理员和提交者一起审核,需要做详细测试,确认无误后更新组件
- 扩展组件代码
- 组件管理员和提交者一起审核,需要做冒烟测试,确认无误后更新组件
- 只是修改配置,无组件代码更新
sdk_xxx组件
该组件为芯片厂商对接完YoC后,提交1520测试的sdk_xxx组件,其可以包括多个solution、demo、以及所有依赖的组件。
文件属性
所有文件属性必须是只读权限。