7.1. Сообщения об ошибках в программном обеспечении

7.2. Сообщения об ошибках в документации

7.1. Сообщения об ошибках в программном обеспечении

Сообщение об ошибке является существенной помощью разработке PostGIS. Наилучнее сообщение об ошибке должно содержать информацию позволяющую разработчикам PostGIS воспроизвести эту ошибку. Поэтому в идеале сообщение должно содержать скрипт, вызывающий ошибку и всевозможную информацию об окружении, в котором эта ошибка проявилась. Полезная информация может быть получена вызовом SELECT postgis_full_version() [для postgis] и SELECT version() [для postgresql].

Если вы используете не последний релиз, вам следует сначала посмотреть release changelog, чтобы узнать не исправлена ли уже ваша ошибка.

Использование PostGIS bug tracker гарантирует, что ваше сообщение не будет проигнорировано, и что вы будете информированы о связанном с ним процессе. Перед сообщением о новой ошибке, пожалуйста, посмотрите не присутствует ли она уже в базе, и, если присутствует, пожалуйста, добавьте любую новую информацию о нем.

Перед подготовкой нового сообщения вы можете прочесть статью Simon Tatham о том Как правильно сообщать об ошибке.

7.2. Сообщения об ошибках в документации

Документация должна точно отражать возможности и поведение программного обеспечения. Если это не так, возможно проблема в ошибке программы или в недостаточной или ошибочной документации.

Ошибки документации также могут быть заявлены через PostGIS bug tracker.

Если ваше изменение небольшое, просто опишите его в новом тикете, будучи как можно более конкретным и указав место в документации.

Если изменения более обширные, предпочтительна заплатка к Subversion. Применение заплатки под Unix является процессом из 4 шагов (предполагается, что Subversion установлен):

1. Загрузите копию PostGIS' Subversion trunk. Если вы используете Unix, введите:

   svn checkout http://svn.refractions.net/postgis/trunk/

   This will be stored in the directory ./trunk

2. Сделайте ваши изменения в документации используя подходящий редактор. Если вы используете Unix, введите:

   vi trunk/doc/postgis.xml

   Отметим, что документация ведется в SGML а не HTML, так что, если вы с ней не знакомы, пожалуйста ознакомьтесь с примером.

3. Создайте заплатку содержащую изменения относительной главной копии документации. Если вы используете Unix, введите:

   svn diff trunk/doc/postgis.xml > doc.patch

4. Добавьте заплатку к новому тикету в bug tracker.

Последнее обновление: August 14 2008
(Наверх)