某些简单的更改类型不需要在变更日志中过多详细说明。
如果更改的描述足够简短,它可以作为自己的标题行。
2019-08-29 Eli Zaretskii <[email protected]> * lisp/simple.el (kill-do-not-save-duplicates): Doc fix. (Bug#36827)
当你以简单的方式更改函数的调用序列,并且你更改了所有调用该函数的代码以使用新的调用序列时,不需要为所有你更改的调用者单独创建条目。只需在被调用的函数的条目中写入“所有调用者已更改”——就像这样:
* keyboard.c (Fcommand_execute): New arg SPECIAL. All callers changed.
当你只更改注释或文档字符串时,为文件编写一个条目就足够了,无需提及函数。对于变更日志来说,仅需“文档修复”就足够了。
当你对许多文件进行更改,这些更改是机械地从一个基础更改衍生而来时,描述基础更改就足够了。以下是一个影响存储库中所有文件的更改示例:
2019-01-07 Paul Eggert <[email protected]> Update copyright year to 2019 Run 'TZ=UTC0 admin/update-copyright $(git ls-files)'.
测试套件文件是软件的一部分,因此我们建议将其视为代码,以进行变更日志记录。
对于非软件文件(手册、帮助文件、媒体文件等),从技术上讲,没有必要创建变更日志条目。这是因为它们不易受到难以理解的错误的影响。要纠正错误,你无需了解错误段落的历史;只需将文件内容与实际情况进行比较即可。
但是,当项目从其贡献者那里获得版权转让时,应该为非软件文件保留变更日志,以便更准确地记录作者身份。因此,我们建议为项目手册的 Texinfo 源文件保留变更日志。