OpenHarmony开源义务履行声明文件收集工具使用说明

简介

本工具集是一组Python脚本,用于在OpenHarmony系统中自动收集模块和系统的许可证及开源信息,并生成标准化的开源声明文件。这些工具旨在确保OpenHarmony项目严格遵守开源许可协议。

工具组成

  • ohos/notice/collect_module_notice_file.py: 递归搜索指定模块目录下的所有许可证和开源文件,提取并写入收集到的信息,生成JSON格式和开源声明的文件。
  • ohos/notice/collect_system_notice_files.py: 解析包含子系统和模块信息的JSON文件,复制相关的开源声明文件到指定目录,并将收集到的开源声明文件压缩成ZIP文件。
  • ohos/notice/merge_notice_files.py: 合并多个开源声明文件(包括文本和XML格式)为一个文件,提取并处理收集到的开源声明信息,生成文本格式和XML格式的开源生命文件,并将生成的XML开源声明文件压缩成gzip格式。
  • ohos/notice/notice.gni: 定义了在构建过程中收集和处理开源声明文件的模板和参数,设置了调用开源声明文件收集脚本的路径、参数和命令。

功能特点

  • 自动化: 简化了许可证信息的收集和管理。
  • 标准化: 生成的开源声明文件格式统一,便于后续处理。
  • 集成: 与OpenHarmony构建框架无缝集成。

使用方法

每个脚本的使用方法可能略有不同,通常需要通过命令行参数指定输入和输出目录。请参考各脚本的具体文档获取详细的使用说明。notice.gni文件用于构建系统内部,开发者无需直接使用。