第 14 章 报告问题

目录

14.1. 报告软件错误

有效报告错误是帮助 PostGIS 开发的基本方法。 最有效的错误报告是使 PostGIS 开发人员能够重现它,因此它最好包含触发它的脚本以及有关检测到它的环境的所有信息。 运行 SELECT postgis_full_version() [对于 PostGIS] 和 SELECT version() [对于 postgresql] 可以提取足够好的信息。

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

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

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

14.2. 报告文档问题

文档应准确反映软件的功能和行为。 如果没有,可能是因为软件错误或文档错误或缺陷。

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

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

如果您的更改更广泛,那么补丁绝对是首选。 这是 Unix 上的四步过程(假设您已经安装了 git ):

Before editing or building the manual, read the repository's documentation development guide. It covers the executable example, generated figure, validation, HTML, and PDF workflows used by the manual.

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