← Back to branch summary

~ubuntu-branches/ubuntu/trusty/postgis/trusty-security

« back to all changes in this revision

Viewing changes to doc/reporting.xml

  • Committer: Bazaar Package Importer
  • Author(s): Francesco Paolo Lovergine
  • Date: 2009-12-11 13:10:34 UTC
  • mfrom: (1.1.9 upstream) (5.2.1 experimental)
  • Revision ID: james.westby@ubuntu.com-20091211131034-wmsz69wxvt95pe5r
Tags: 1.4.0-2
http://bugs.debian.org/559587
http://bugs.debian.org/560409
* Upload to unstable.
* Better parameterized debian/rules against postgis $(VERSION).
* Added dblatex and libcunit1-dev among build-deps.
* Added postgis_comments.sql to contrib/ SQL templates.
* Dropping 8.3 support, no more supported for squeeze.
  (closes: #559587)
* Do not stop on error in postrm if the target dir does not exist.
  (closes: #560409)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reporting.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<chapter>
 
3
  <title>Reporting Problems</title>
 
4
 
 
5
  <sect1>
 
6
    <title>Reporting Software Bugs</title>
 
7
 
 
8
    <para>Reporting bugs effectively is a fundamental way to help PostGIS
 
9
    development. The most effective bug report is that enabling PostGIS
 
10
    developers to reproduce it, so it would ideally contain a script
 
11
    triggering it and every information regarding the environment in which it
 
12
    was detected. Good enough info can be extracted running <code>SELECT
 
13
    postgis_full_version()</code> [for postgis] and <code>SELECT
 
14
    version()</code> [for postgresql].</para>
 
15
 
 
16
    <para>If you aren't using the latest release, it's worth taking a look at
 
17
    its <ulink url="http://svn.refractions.net/postgis/trunk/NEWS">release
 
18
    changelog</ulink> first, to find out if your bug has already been
 
19
    fixed.</para>
 
20
 
 
21
    <para>Using the <ulink
 
22
    url="http://code.google.com/p/postgis/issues/list">PostGIS bug
 
23
    tracker</ulink> will ensure your reports are not discarded, and will keep
 
24
    you informed on its handling process. Before reporting a new bug please
 
25
    query the database to see if it is a known one, and if it is please add
 
26
    any new information you have about it.</para>
 
27
 
 
28
    <para>You might want to read Simon Tatham's paper about <ulink
 
29
    url="http://www.chiark.greenend.org.uk/~sgtatham/bugs.html">How to Report
 
30
    Bugs Effectively</ulink> before filing a new report.</para>
 
31
  </sect1>
 
32
 
 
33
  <sect1>
 
34
    <title>Reporting Documentation Issues</title>
 
35
 
 
36
    <para>The documentation should accurately reflect the features and
 
37
    behavior of the software. If it doesn't, it could be because of a software
 
38
    bug or because the documentation is in error or deficient.</para>
 
39
 
 
40
    <para>Documentation issues can also be reported to the <ulink
 
41
    url="http://code.google.com/p/postgis/issues/list">PostGIS bug
 
42
    tracker</ulink>.</para>
 
43
 
 
44
    <para>If your revision is trivial, just describe it in a new bug tracker
 
45
    issue, being specific about its location in the documentation.</para>
 
46
 
 
47
    <para>If your changes are more extensive, a Subversion patch is definitely
 
48
    preferred. This is a four step process on Unix (assuming you already have
 
49
    <ulink url="http://subversion.tigris.org/">Subversion</ulink>
 
50
    installed):</para>
 
51
 
 
52
    <orderedlist>
 
53
      <listitem>
 
54
        <para>Check out a copy of PostGIS' Subversion trunk. On Unix,
 
55
        type:</para>
 
56
 
 
57
        <para><command>svn checkout
 
58
        http://svn.refractions.net/postgis/trunk/</command></para>
 
59
 
 
60
        <para>This will be stored in the directory ./trunk</para>
 
61
      </listitem>
 
62
 
 
63
      <listitem>
 
64
        <para>Make your changes to the documentation with your favorite text
 
65
        editor. On Unix, type (for example):</para>
 
66
 
 
67
        <para><command>vi trunk/doc/postgis.xml</command></para>
 
68
 
 
69
        <para>Note that the documentation is written in SGML rather than HTML,
 
70
        so if you are not familiar with it please follow the example of the
 
71
        rest of the documentation.</para>
 
72
      </listitem>
 
73
 
 
74
      <listitem>
 
75
        <para>Make a patch file containing the differences from the master
 
76
        copy of the documentation. On Unix, type:</para>
 
77
 
 
78
        <para><command>svn diff trunk/doc/postgis.xml &gt;
 
79
        doc.patch</command></para>
 
80
      </listitem>
 
81
 
 
82
      <listitem>
 
83
        <para>Attach the patch to a new issue in bug tracker.</para>
 
84
      </listitem>
 
85
    </orderedlist>
 
86
  </sect1>
 
87
</chapter>
 
 
b'\\ No newline at end of file'