Changes between Version 4 and Version 5 of BugReporting

Timestamp:

Feb 19, 2016, 5:19:24 PM (8 years ago)

Author:

figaro

Comment:

Cosmetic changes

BugReporting

@@ +1 @@
+[[PageOutline(2-5,Contents,pullout)]]
+
 = How to Report Bugs
 
@@ -11 +13 @@
 Plugins should use debug messages logged to file to help determining where the problem occurs. If your bug is not only functional, but it is provided by error message or traceback, you should collect the debug messages too. There are two ways to enable logging on debug level.
 
-First, the hard one, is described [http://trac.edgewall.org/wiki/TracLogging here]. For our purposes it is needed to set these variables in your `trac.ini` configuration file:
+First, the hard one, is described at [t:TracLogging]. For our purposes it is needed to set these variables in your `trac.ini` configuration file:
 
 {{{#!ini
@@ -21 +23 @@
 The second one is easier but you have to have had WebAdminPlugin installed. Just go to "Admin" section and "Logging" page and set there "Type" field to "file" and "Log level" field to "DEBUG".
 
-You will probably need to restart your web server after changing that in both cases. Then replicate your bug again go to "<trac_environment_path>/log/" folder and open log file named trac.log (by default). There collect any relevant lines near error message that you think are relevant or few tens if you are not sure about that and post them in the ticket. Don't forget to enclose these lines in triple brackets (!{{{ }}}) when pasting the content into a ticket.
+You will probably need to restart your web server after changing that in both cases. Then replicate your bug again go to "<trac_environment_path>/log/" folder and open log file named trac.log (by default). There collect any lines near the error message that you think are relevant or few tens if you are not sure about that and post them in the ticket. Don't forget to enclose these lines in triple brackets (!{{{ }}}) when pasting the content into a ticket.
 
 == Describing Your System
 
-Many bugs are platform dependent, so you should sumarize your system information in the begining of the ticket. Relevant is your exact Trac version (0.10.3, SVN trunk r3500, ...), web server you are running trac at (Apache+CGI, Apache+mod_python, tracd, ...), database backend (sqlite, PostgreSQL, MySQL, ...), database bindings (pysqlite, ...), operating system (Windows, Linux, MacOS, ...) and of course the plugin's version. Example:
+Many bugs are platform dependent, so you should sumarize your system information in the begining of the ticket. Relevant is your exact Trac version (0.10.3, SVN trunk r3500, ...), the web server you are running Trac at (Apache+CGI, Apache+mod_python, tracd, ...), database backend (sqlite, PostgreSQL, MySQL, ...), database bindings (pysqlite, ...), operating system (Windows, Linux, MacOS, ...) and of course the plugin's version. Example:
 
 {{{
@@ -35 +37 @@
 }}}
 
-== Summary
-
 Not all information is needed in all cases, but if you are not sure, it's better to put all of it in the ticket.