Mention the option to submit bug reports via a web-form. Minor
authorTom Lane
Sun, 18 Nov 2001 07:14:49 +0000 (07:14 +0000)
committerTom Lane
Sun, 18 Nov 2001 07:14:49 +0000 (07:14 +0000)
copy editing.

doc/src/sgml/problems.sgml

index 58d77c8d1af99035afc379d250926ca9bd016eba..a0f3a9501fbf60897a56d871ef18192fde03c094 100644 (file)
@@ -1,5 +1,5 @@
 
 
 
@@ -8,7 +8,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/problems.sgml,v 2.9 2001/09/13 15:55:23 pet
  
   When you find a bug in PostgreSQL we want to
   hear about it. Your bug reports play an important part in making
-  PostgreSQL more reliable because even the utmost
+  PostgreSQL more reliable, because even the utmost
   care cannot guarantee that every part of PostgreSQL will work on every
   platform under every circumstance.
  
@@ -66,7 +66,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/problems.sgml,v 2.9 2001/09/13 15:55:23 pet
     
      
       A program accepts invalid input without a notice or error message.
-      Keep in mind that your idea of invalid input might be our idea of
+      But keep in mind that your idea of invalid input might be our idea of
       an extension or compatibility with traditional practice.
      
     
@@ -83,9 +83,10 @@ $Header: /cvsroot/pgsql/doc/src/sgml/problems.sgml,v 2.9 2001/09/13 15:55:23 pet
   
 
   
-   Being slow or resource-hogging is not necessarily a bug. Read the documentation
-   or ask on one of the mailing lists for help in tuning your applications. Failing
-   to comply to SQL is not a bug unless compliance for the
+   Being slow or resource-hogging is not necessarily a bug. Read the
+   documentation or ask on one of the mailing lists for help in tuning your
+   applications. Failing to comply to the SQL standard is
+   not necessarily a bug either, unless compliance for the
    specific feature is explicitly claimed.
   
 
@@ -161,9 +162,9 @@ $Header: /cvsroot/pgsql/doc/src/sgml/problems.sgml,v 2.9 2001/09/13 15:55:23 pet
      
      
       
-       In case of fatal errors, the error message provided by the client might
-       not contain all the information available. In that case, also look at the
-       log output of the database server. If you do not keep your server
+       In case of fatal errors, the error message reported by the client might
+       not contain all the information available. Please also look at the
+       log output of the database server. If you do not keep your server's log
        output, this would be a good time to start doing so.
       
      
@@ -179,7 +180,7 @@ $Header: /cvsroot/pgsql/doc/src/sgml/problems.sgml,v 2.9 2001/09/13 15:55:23 pet
       Especially refrain from merely saying that This is not what SQL says/Oracle
       does. Digging out the correct behavior from SQL
       is not a fun undertaking, nor do we all know how all the other relational
-      databases out there behave. (If your problem is a program crash you can
+      databases out there behave. (If your problem is a program crash, you can
       obviously omit this item.)
      
     
@@ -208,8 +209,9 @@ $Header: /cvsroot/pgsql/doc/src/sgml/problems.sgml,v 2.9 2001/09/13 15:55:23 pet
       programs also support a  option; at least
       postmaster --version and psql --version
       should work.
-      If the function or the options do not exist then your version is probably
-      old enough.  You can also look into the README file
+      If the function or the options do not exist then your version is
+      more than old enough to warrant an upgrade.  You can also look into the
+      README file 
       in the source directory or at the
       name of your distribution file or package name.
       If you run a prepackaged version, such as RPMs, say so, including any
@@ -254,13 +256,16 @@ $Header: /cvsroot/pgsql/doc/src/sgml/problems.sgml,v 2.9 2001/09/13 15:55:23 pet
 
   
    When writing a bug report, please choose non-confusing terminology.
-   The software package as such is called PostgreSQL,
-   sometimes Postgres for short. (Sometimes
-   the abbreviation Pgsql is used but don't do that.) When you
+   The software package in total is called PostgreSQL,
+   sometimes Postgres for short. If you
    are specifically talking about the backend server, mention that, do not
-   just say Postgres crashes. The interactive frontend is called
-   psql and is for all intends and purposes completely separate
-   from the backend.
+   just say Postgres crashes.  A crash of a single
+   backend server process is quite different from crash of the parent
+   postmaster process; please don't say the postmaster
+   crashed when you mean a single backend went down, nor vice versa.
+   Also, client programs such as the interactive frontend psql
+   are completely separate from the backend.  Please try to be specific
+   about whether the problem is on the client or server side.
   
  
 
@@ -270,10 +275,18 @@ $Header: /cvsroot/pgsql/doc/src/sgml/problems.sgml,v 2.9 2001/09/13 15:55:23 pet
   
    In general, send bug reports to the bug report mailing list at
-   You are invited to find a descriptive subject for your email
+   You are requested to use a descriptive subject for your email
    message, perhaps parts of the error message.
   
 
+   
+   Another method is to fill in the bug report web-form available
+   at the project's web site
+   http://www.postgresql.org/.
+   Entering a bug report this way causes it to be mailed to the
+   [email protected] mailing list.
+  
+
    
    Do not send bug reports to any of the user mailing lists, such as
    [email protected] or
@@ -290,13 +303,14 @@ $Header: /cvsroot/pgsql/doc/src/sgml/problems.sgml,v 2.9 2001/09/13 15:55:23 pet
    development of PostgreSQL and it would be nice
    if we could keep the bug reports separate. We might choose to take up a
    discussion
-   about your bug report on it, if the bug needs more review.
+   about your bug report on pgsql-hackers, if the problem needs more review.
   
 
   
-   If you have a problem with the documentation, send email to
-   the documentation mailing list [email protected].
-   Mention the document, chapter, and sections in your problem report.
+   If you have a problem with the documentation, the best place to report it
+   is the documentation mailing list [email protected].
+   Please be specific about what part of the documentation you are unhappy
+   with.
   
  
   
@@ -310,9 +324,10 @@ $Header: /cvsroot/pgsql/doc/src/sgml/problems.sgml,v 2.9 2001/09/13 15:55:23 pet
    
     Due to the unfortunate amount of spam going around, all of the above
     email addresses are closed mailing lists. That is, you need to be
-    subscribed to a list to be allowed to post on it. If you simply
-    want to send mail but do not want to receive list traffic, you can
-    subscribe and set your subscription option to nomail.
+    subscribed to a list to be allowed to post on it.  (You need not be
+    subscribed to use the bug report web-form, however.)
+    If you would like to send mail but do not want to receive list traffic,
+    you can subscribe and set your subscription option to nomail.
     For more information send mail to
     with the single word help in the body of the message.