Debian Message的格式规范是什么
导读:Debian Message 格式规范(以 changelog 为核心) Debian 系统中,“Message”通常指debian/changelog文件(变更日志),它是记录软件包变更历史的关键元数据文件,用于说明每次版本更新的详细内容...
Debian Message 格式规范(以 changelog 为核心)
Debian 系统中,“Message”通常指debian/changelog文件(变更日志),它是记录软件包变更历史的关键元数据文件,用于说明每次版本更新的详细内容。其格式需严格遵循以下规范:
1. 基本结构(必填项)
变更日志的单个条目需按固定顺序包含以下核心字段:
- Package(软件包名称):标识软件包的唯一名称(如
gst-plugins-base)。 - Version(版本号):遵循上游版本号+Debian 修订号的格式(如
(1.14.4-2)),其中1.14.4是上游版本,2是 Debian 的修订次数。 - Distribution(发行版):指定软件包适用的 Debian 发行版(如
unstable、testing、stable或具体版本号如bookworm)。 - Urgency(紧急程度):表示更新的紧迫性,取值为
high(高危,如安全修复)、medium(中危,如功能改进)、low(低危,如文档更新)或no(无紧急需求)。
示例片段:
gst-plugins-base (1.14.4-2) unstable;
urgency high
2. 变更详情(必填项)
紧接基本结构之后,需用星号(*)开头每行列出具体变更内容,描述本次更新的修改点。每条变更应简洁明了,若内容过长可换行(后续行需缩进)。变更详情之间需用空行分隔。
示例片段:
* debian/patches/0001-gstrtspconnection-Security-loophole-making-heap-over.patch: Add upstream patch for CVE-2019-9928 (Closes: #927978).
3. 维护者信息(必填项)
变更详情结束后,需用**双破折号(–)**分隔,并添加维护者信息和日期:
- Maintainer(维护者):格式为“姓名 + 空格 + 电子邮件地址”(如
Wireshark < wireshark@example.com>),姓名与邮箱间需保留两个空格。 - Date(日期):维护者添加变更的日期,格式为
YYYY-MM-DD HH:MM:SS +ZZZZ(如Wed, 27 Jan 2020 00:00:00 +0000),其中时区需明确标注。
示例片段:
-- Wireshark <
wireshark@example.com>
Wed, 27 Jan 2020 00:00:00 +0000
4. 可选部分
- 紧急程度描述:
urgency字段后可添加空行及可选描述(如说明紧急的原因),但该部分会被dpkg-parsechangelog命令过滤掉。 - 空白行:变更详情之间、变更详情与维护者信息之间的空行用于分隔内容,确保格式清晰(
dpkg-parsechangelog会将空行包含在输出中)。
5. 格式约束(技术要求)
- 行宽限制:变更详情的每行建议不超过76列(Git 推荐的提交信息行宽),避免
lintian工具报debian-changelog-line-too-long警告(超过80列会触发)。 - 标点规范:变更详情的首句需以句号(
.)结尾(若首句后有额外描述,可用冒号:代替),确保gbp-dch等工具生成一致的日志格式。 - Git 提交关联:若变更对应 Git 提交,提交信息的首行应与变更日志的首条详情一致(如
Add upstream patch for CVE-2019-9928),便于追溯变更来源。
以上规范确保了 debian/changelog 文件的一致性和可读性,便于维护者跟踪软件包的变更历史,也符合 Debian 打包生态的要求。
声明:本文内容由网友自发贡献,本站不承担相应法律责任。对本内容有异议或投诉,请联系2913721942#qq.com核实处理,我们将尽快回复您,谢谢合作!
若转载请注明出处: Debian Message的格式规范是什么
本文地址: https://pptw.com/jishu/744458.html
