第 14 章:报告问题

目录

14.1. 报告软件错误

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

如果您没有使用最新版本,最好先查看其发布变更日志,以了解您的错误是否已修复。

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

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

14.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. 将补丁附加到错误跟踪器中的新问题。