第 13 章。报告问题

目录
13.1. 报告软件错误
13.2. 报告文档问题

13.1. 报告软件错误

有效报告错误是帮助 PostGIS 开发的一项基本方式。最有效的错误报告是让 PostGIS 开发人员能够重现错误,因此理想情况下应包含触发错误的脚本以及检测到错误时环境的每条信息。可以通过运行 SELECT postgis_full_version() [对于 PostGIS] 和 SELECT version() [对于 postgresql] 提取足够的信息。

如果您未使用最新版本,则值得先查看其 发行版变更日志,以了解您的错误是否已修复。

使用 PostGIS 错误跟踪器 将确保您的报告不会被丢弃,并将让您了解其处理过程。在报告新错误之前,请查询数据库以查看它是否是已知错误,如果是,请添加您掌握的任何新信息。

在提交新报告之前,您可能需要阅读 Simon Tatham 关于 如何有效报告错误 的论文。

13.2. 报告文档问题

文档应准确反映软件的功能和行为。如果文档没有准确反映,则可能是由于软件错误或文档有误或不足。

文档问题也可以报告给 PostGIS 错误跟踪器

如果您的修订很小,只需在新的错误跟踪器问题中描述它,并具体说明它在文档中的位置。

如果您的更改更广泛,则绝对首选修补程序。这是 Unix 上的一个四步流程(假设您已安装 git

  1. 克隆 PostGIS 的 git 存储库。在 Unix 上,键入

    git clone https://git.osgeo.org/gitea/postgis/postgis.git

    这将存储在 postgis 目录中

  2. 使用你最喜欢的文本编辑器对文档进行更改。在 Unix 中,键入(例如)

    vim doc/postgis.xml

    请注意,文档是用 DocBook XML 而不是 HTML 编写的,因此如果你不熟悉它,请遵循文档其余部分的示例。

  3. 创建一个包含与文档主副本差异的补丁文件。在 Unix 中,键入

    git diff doc/postgis.xml > doc.patch

  4. 将补丁附加到错误跟踪器中的新问题。