FreeRTOS 清单文件说明 - FreeRTOS
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

FreeRTOS 清单文件说明

所有基于 LTS FreeRTOS 的项目都需要一个清单文件,以帮助客户描述正在使用的依赖项版本、哪些库是 LTS,以及帮助客户更快地评估和使用软件的其他元数据。

文件应满足以下要求:

  • 命名 manifest.yml

  • 放置在 /vendors/vendor/boards/board/ 目录中

  • 采用 YAML 格式并遵循 YAML 1.2 规范

参数可以采用任何顺序,但我们建议您按下面列出的顺序放置参数,以获得最佳可读性。将评论添加到该文件中,以帮助客户使用或了解您的程序包。

文件路径

位于程序包或库的根目录中。每个软件包只有一个清单。引入的依赖项可能具有自己的清单文件。

参数
name

程序包的名称。所有空格应替换为下划线 (_)。例如, My project name - 2020 应更改为 My_project_name_-_2020

  • 类型:字符串

  • 必需:true

  • minLength:1

  • maxLength: 40

version

程序包的版本。版本可以是发布版本或版本标签。

  • 类型:字符串

  • 必需:true

  • minLength:1

  • maxLength: 30

description

程序包的人类可读格式的描述。描述应明确描述程序包是什么以及它提供什么。

  • 类型:字符串

  • 必需:true

  • minLength: 30

  • maxLength: 255

dependencies

用户成功构建此程序包所需的所有第一级依赖项的列表,这些依赖项可以由 Git、Subversion 或 Mercurial 源代码主机检索。请勿包含无法通过 Git、SVG 或 hg 提供的依赖项。请勿包含用于测试、文档生成或开发的依赖项。为确保一般公众获得良好的体验,我们建议您避免列出门控或私有的依赖项。

  • 类型:数组

  • 必需:false

  • minLength: 0

dependencies[].name

依赖项的程序包名称。这必须与在依赖项的 name 参数中找到的程序包名称匹配。

  • 类型:字符串

  • 必需:true

  • minLength:1

  • maxLength: 40

依赖项[.version

依赖项的版本。版本可以是发布版本或版本标签。如果程序包本身包含任何依赖项,则版本必须与依赖项中的清单文件匹配。

  • 类型:字符串

  • 必需:true

  • minLength:1

  • maxLength: 30

dependencies[].repository

描述依赖项源代码的位置。

  • 类型:词典

  • 必需:true

dependencies[.repository.type

存储库的类型。

  • 类型:字符串

  • 必需:true

  • 枚举:[git, svn, hg]

dependencies[.repository.url

存储库位置的 URL。这必须是具有协议前缀的完整 URL(例如https://github.com/ACCOUNT_NAME/REPO_NAME).

  • 类型:字符串

  • 必需:true

dependencies[.repository.branch

使用的依赖项的分支。如果程序包使用默认主分支,请不要包含此参数以至少保留清单的长度。

  • 类型:字符串

  • 必需:false

license

库的 SPDX 许可证标识符。有关完整列表,请参阅 https://spdx.org/licenses/。它应该与存储库根目录中包含的LICENSE文件匹配(如果存在)。

  • 类型:字符串

  • 必需:true