[mapserver-commits] r8173 - trunk/docs/howto

[svn at osgeo.org]

Author: hobu
Date: 2008-12-02 23:27:22 -0500 (Tue, 02 Dec 2008)
New Revision: 8173

Modified:
   trunk/docs/howto/bug_submission.txt
Log:
reformat

Modified: trunk/docs/howto/bug_submission.txt
===================================================================
--- trunk/docs/howto/bug_submission.txt	2008-12-02 20:28:42 UTC (rev 8172)
+++ trunk/docs/howto/bug_submission.txt	2008-12-03 04:27:22 UTC (rev 8173)
@@ -1,24 +1,44 @@
-Bugs should be submitted into Trac.  You will first need to login using an OSGeo userid.
+.. _bugs:
 
+*****************************************************************************
+ Bug Submission
+*****************************************************************************
+
+Bugs should be submitted into Trac. You will first need to login using an
+OSGeo userid.
+
 http://www.osgeo.org/osgeo_userid
 
 http://trac.osgeo.org/mapserver/
 
 Please keep the following issues in mind when submitting a bug:
 
-1. Please set the *Component* carefully. It will determine who the bug is assigned to by default.
+1. Please set the *Component* carefully. It will determine who the bug is
+   assigned to by default.
 
 2. Set a meaningful yet reasonably brief description.
 
 3. Set the version of MapServer you are using.
 
-4. In your description please indicate whether you built from source or got it from an prepared binary build.
+4. In your description please indicate whether you built from source or got it
+   from an prepared binary build.
 
-The most important thing when reporting a bug is to boil down a minimum example that is needed to reproduce the bug.  That means a minimal mapfile + any data files it depends on.  Remove everything from the map file that isn't needed to reproduce the bug.
+The most important thing when reporting a bug is to boil down a minimum
+example that is needed to reproduce the bug. That means a minimal mapfile +
+any data files it depends on. Remove everything from the map file that isn't
+needed to reproduce the bug.
 
-The developers often dislike having to spend the first 30 minutes working on a bug, having to fix paths, remove unnecessary layers,  removing references to external symbols or fonts that were not included or even needed and otherwise doctoring your test case to get it to a point when they can actually use it.
+The developers often dislike having to spend the first 30 minutes working on a
+bug, having to fix paths, remove unnecessary layers, removing references to
+external symbols or fonts that were not included or even needed and otherwise
+doctoring your test case to get it to a point when they can actually use it.
 
-If the bug is easily demonstrated with "shp2img", without the need to setup a proper web service and test it through http, then please show it that way.  If a standalone mapscript script can demonstrate a problem without it having to be a web service, likewise submit it that way.
+If the bug is easily demonstrated with ":ref:`shp2img`", without the need to
+setup a proper web service and test it through http, then please show it that
+way. If a standalone mapscript script can demonstrate a problem without it
+having to be a web service, likewise submit it that way.
 
-The chances of a bug being addressed in a timely manner is directly related to the speed with which the developer can reproduce the bug.  If you make that hard for the developer, chances are the bug will be given up on or ignored for quite a while.
-
+The chances of a bug being addressed in a timely manner is directly related to
+the speed with which the developer can reproduce the bug. If you make that
+hard for the developer, chances are the bug will be given up on or ignored for
+quite a while.