本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
FreeRTOS 清单文件说明
所有基于 LTS 的 FreeRTOS 项目都需要一个清单文件,以帮助客户划分正在使用的依赖关系版本、哪些库是 LTS,以及帮助客户更快地评估和使用软件的其他元数据。
该文件应满足以下要求:
-
名为
manifest.yml
-
放置在
directoryfreertos
/vendors/vendor
/boards/board
/ -
采用 YAML 格式并遵循YAML 1.2 规格
参数可以按任意顺序排列,但我们建议您按照下面列出的顺序放置它们,以获得最佳的可读性。向文件添加备注,以帮助买家使用或理解您的包裹。
- 文件路径
-
位于软件包或库的根目录。每个程序包只能有一个清单。引入的依赖项可能有自己的清单文件。
- 参数
-
- name
-
程序包的名称。所有空格都应该用下划线 (_) 替换。例如,
My project name - 2020
应该更改为My_project_name_-_2020
.-
类型:字符串
-
必需执行:true
-
MinLength: 1
-
MaxLength: 40
-
- 版本
-
程序包的版本。版本可以是发布版本或版本标签。
-
类型:字符串
-
必需执行:true
-
MinLength: 1
-
MaxLength: 30
-
- description
-
用户可读的程序包描述。描述应清楚地描述包裹是什么以及它提供了什么。
-
类型:字符串
-
必需执行:true
-
MinLength: 30
-
MaxLength: 255
-
- dependencies
-
用户成功构建此软件包所需的所有第一级依赖项的列表,这些依赖项可由 Git、Subversion 或 Mercurial 源代码主机检索。不要包含通过 Git、SVG 或 hg 不可用的依赖项。不要包括用于测试、文档生成或开发的依赖关系。为了确保一般公众获得良好的体验,我们建议您避免发布封闭或私有的依赖关系。
-
类型:数组
-
需要:false
-
MinLength: 0
- 依赖项 [] .name
-
依赖项的程序包名称。这必须与依赖项中找到的软件包名称匹配
name
参数。-
类型:字符串
-
必需执行:true
-
MinLength: 1
-
MaxLength: 40
-
- 依赖项 [] .version
-
依赖项的版本。版本可以是发布版本或版本标签。如果软件包本身包含任何依赖项,则版本必须与依赖项中的清单文件匹配。
-
类型:字符串
-
必需执行:true
-
MinLength: 1
-
MaxLength: 30
-
- 依赖项 [] .repository
-
描述依赖项源代码的位置。
-
类型:词典
-
必需执行:true
-
- 依赖项 [] .repository .type
-
存储库的类型。
-
类型:字符串
-
必需执行:true
-
枚举:[git、svn、hg]
-
- 依赖项 [] .repository .url
-
存储库位置的 URL。这必须是带协议前缀的完整 URL(例如,https://github.com/
ACCOUNT_NAME
/REP_NAME
)。-
类型:字符串
-
必需执行:true
-
- 依赖项 [] .repository .branch
-
使用的依赖项的分支。如果软件包使用默认的主分支,请不要包含此参数以将清单的长度保持在最低限度。
-
类型:字符串
-
需要:false
-
-
- 执照
-
库的 SPDX 许可证标识符。有关完整列表,请参阅https://spdx.org/licenses/
. 它应该与 LICENSE
存储库的根目录中包含的文件(如果存在)。-
类型:字符串
-
必需执行:true
-