本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
FreeRTOS 清单文件说明
需要清单文件Amazon IoT Device Tester才能识别正在使用的版本和库。它可以帮助客户描述版本、库依赖关系和元数据。
文件应满足以下要求:
-
文件必须命名为
manifest.yml
。 -
它必须位于库或包的基础文件夹中。
-
它必须采用 YAML 格式并符合 YAML 1.2 规范
。
参数可以按任意顺序排列,但为了获得最佳可读性,我们建议您按照下面列出的顺序排列它们。向文件添加评论以帮助客户使用您的包裹。
- 文件路径
-
位于软件包或库的根目录下。每个包只有一个清单文件。引入的依赖项可能有自己的清单文件。
- 参数
-
- name
-
程序包的名称。所有空格都应替换为下划线 (_)。例如,
My project name - 2020
应更改为My_project_name_-_2020
。-
类型:字符串
-
必填项:真的
-
最小长度
-
最大长度:40
-
- version
-
软件包的版本。版本可以是发行版本或版本标签。
-
类型:字符串
-
必填项:真的
-
最小长度
-
最大长度
-
- description
-
用户可读的程序包描述。描述应清楚地描述软件包是什么及其提供的内容。
-
类型:字符串
-
必填项:真的
-
最小长度
-
最大长度:255
-
- dependencies
-
用户成功构建此软件包所需的所有第一级依赖项的列表,这些依赖项可由 Git、Subversion 或 Mercurial 源代码主机检索。不要包含无法通过 Git、SVG 或 hg 获得的依赖关系。不要包含用于测试、文档生成或开发的依赖关系。为了提升良好的体验,我们建议您避免列出封闭或私有依赖关系。
-
类型:数组
-
必填项:假
-
最小长度
- 依赖关系 [] .name
-
依赖项的包名。这必须与依赖项
name
参数中找到的包名称相匹配。-
类型:字符串
-
必填项:真的
-
最小长度
-
最大长度:40
-
- 依赖关系 [] .version
-
依赖关系的版本。版本可以是发行版本或版本标签。如果包本身包含任何依赖关系,则版本必须与依赖项中的清单文件相匹配。
-
类型:字符串
-
必填项:真的
-
最小长度
-
最大长度
-
- 依赖关系 [] .存储库
-
描述依赖源代码的位置。
-
类型:字典
-
必填项:真的
-
- 依赖关系 [] .repository.type
-
存储库的类型。
-
类型:字符串
-
必填项:真的
-
枚举:[git、svn、hg]
-
- 依赖关系 [] .repository.url
-
存储库位置的 URL。这必须是带有协议前缀的完整网址(例如 https://github.com/ ACCO
UNT_NAME
/REPO_NAM
E)。-
类型:字符串
-
必填项:真的
-
- 依赖关系 [] .repository.path
-
依赖项的项目工作空间的相对路径。
-
类型:字符串
-
必填项:真的
-
- 依赖关系 [] .repository.branch
-
使用的依赖项的分支。如果软件包使用库的发布分支,请不要包含此参数以将清单的长度保持在最小值。
-
类型:字符串
-
必填项:假
-
-
- 执照
-
库的 SPDX 许可证标识符。完整列表请参阅
。https://spdx.org/licenses/ 如果存在的话,它应该与存储库根目录中包含 LICENSE
的文件相匹配。-
类型:字符串
-
必填项:真的
-