Chapter 16. 报告问题

Table of Contents
16.1. 报告软件错误
16.2. 报告文档问题

16.1. 报告软件错误

有效的错误报告是帮助PostGIS开发的根本途径。最有效的错误报告是使PostGIS开发人员能够重现它,因此理想情况下,它将包含触发它的脚本以及有关检测到它的环境的所有信息。足够好的信息可以在运行时提取 SELECT postgis_full_version() [适用于PostGIS]和 SELECT version() [适用于PostgreSQL]。

如果您使用的不是最新版本,那么值得一看它的 版本更改日志 首先,找出您的错误是否已经修复。

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

你可能想读一下西蒙·塔瑟姆的论文 如何有效地报告漏洞 在提交新的报告之前。

16.2. 报告文档问题

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

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

如果您的修订是琐碎的,只需在新的错误跟踪器问题中描述它,并在文档中详细说明它的位置。

如果您的更改范围更广,补丁肯定是首选。在Unix上,这是一个四个步骤的过程(假设您已经 吉特 已安装):

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

    Git克隆https://git.osgeo.org/gitea/postgis/postgis.git

    该文件将存储在postgis目录中

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

    Vim文档/postgis.xml

    请注意,文档是用DocBook XML而不是HTML编写的,因此如果您不熟悉它,请按照文档其余部分的示例进行操作。

  3. 制作包含与文档主副本不同的补丁文件。在Unix上,键入:

    Git diff文档/postgis.xml > doc.patch

  4. 将补丁附加到Bug Tracker中的新问题上。