移植标准
为方便中间件仓库的后续维护及自动化构建,中间件移植过程中请遵守如下规范:
- 中间件代码使用开源仓库最新的 release 版本。
- 工程仓库应与源码仓库结构保持一致,保留提交记录,便于代码对比及迭代。
- 工程构建目录和安装目录名称分别使用
build-sylixos
和install-sylixos
。 - 每个工程需要创建一个
README-SylixOS.md
文档,其中必须包含以下内容
,其他内容可根据需要进行添加:- 工程的介绍
- 采用的版本
- 源码仓库的地址
- 构建的具体配置/依赖及方法
- 当前验证的情况
注意事项
- 使用 rpath 或直接使用路径的库链接方式需要改成
-Lpath -llibrary_name
的方式链接。 - 中间件编译完成后需使用工程中附带的
tests
和examples
完成验证工作。
关于规范第 1、2 条内容可以使用如下方法将开源仓库移植到内部的中间件仓库。
创建 gitlab 仓库,创建时不使用自述文件初始化仓库。
使用如下指令克隆开源仓库。
# 假设开源仓库最新 release 版本 tag 为 v1.10.0
git clone --branch v1.10.0 --single-branch --no-tags <开源仓库地址>
- 创建并切换到主分支。
git checkout -b master
- 删除所有 tag。
git tag --delete $(git tag)
- 按照如下步骤将克隆下来的仓库推送到 gitlab 仓库。
# 假设软件工厂的 gitlab 仓库地址为 ssh://git@10.*.*.*:****/middleware/lz4.git
git remote remove origin
git remote add origin ssh://git@10.*.*.*:****/middleware/lz4.git
git push -u origin --all
执行完上述步骤之后,远端仓库的一个特定版本已经迁移软件工厂的 gitlab,并保留了完整的提交记录,后续在此基础上修改提交即可。