DokuWiki

It's better when it's simple

User Tools

Site Tools


bugs

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
bugs [2014-02-26 16:52]
ChrisS
bugs [2018-01-03 13:45]
andi [Report a Bug]
Line 1: Line 1:
-====== ​Bugtracking System ​======+====== ​Reporting DokuWiki Bugs ======
  
-:!: DokuWiki is in the process ​of changing its bug tracking system to [[https://​github.com/​splitbrain/​dokuwiki/​issues|github issues]].  ​This page will be updated shortly ​with all the details --- [[user>​ChrisS|ChrisS]] //​2014/​02/​26 16:52//+Every software has bugs. We try to ship the best possible version ​of DokuWiki every time, but errors happen. This page is here to help you with reporting bugs you might encounter.
  
-[[DokuWiki]] has [[http://​bugs.splitbrain.org/​index.php?​project=1|Bugtracking System]] (BTS). Please report all bugs and feature wishes there. When reporting bugs please always give info about the used OS, Webserver and Browser. When asked for, run ''​doku.php?​do=debug''​ and attach the output.+===== Make sure it is Bug =====
  
-**Tests Please:** if you are ableplease attach ​failing ​[[devel:unittesting|unit test]] with your bug report - this really helps //a lot//.+Before ​you report somethingtry to research if the problem you encounter really is a bug. Maybe it is intended behavior for some reason? Maybe there'​s ​a [[:config|setting]] you could tune?
  
-Please read [[http://www.chiark.greenend.org.uk/~sgtatham/​bugs.html|How to Report Bugs Effectively]] before ​submitting ​bug.+You should also search the [[https://forum.dokuwiki.org/|forum]] if people had the same problem ​before. Maybe there'​s ​fix already?
  
-And remember: [[http://​grassouille.org/​post/​Every-time-you-submit-a-bad-bug-report,​-god-kills-a-kitten|Every time you submit a bad bug report, god kills a kitten]].+However, if still in doubt, just open a bug report. We can always close it should it turn out to not be a bug.
  
-===== How to use the bugtracking System ​=====+===== Check if the problem is already reported ​=====
  
-First make sure the bug or feature request isn't already thereEnter some keywords ​in the search box at the top and **choose ​''All Statuses''​** ​this makes sure you also find already closed bugs -- your bug may already be fixed ;-)+All DokuWiki bugs should be reported in our bug tracker at GitHub located at: [[https://​github.com/​splitbrain/​dokuwiki/​issues]]. For bugs in plugins ​and templates use the plugin's own bugtracker ​--- you'll find a link to that on the plugin'​s documentation page.
  
-If you found a bugreport on "your" bug add a comment or attachment if you can provide useful additional information. You can also add your self to the notify list to get informed when the status of the bug changes.+Use the search to check if your problem already has been reported. Also make sure you search through closed bugs as well --- the bug might have been fixed already in development.
  
-If you didn't find your bug use the "Add new task" at the very topTake some time to fill all fields ​you are asked for. +If the bug was reported already, check if you can provide additional information to aid fixing the bug. See below on how. 
 + 
 +===== Report a Bug ===== 
 + 
 +As mentioned above, DokuWiki bugs **have** to be reported at [[https://​github.com/​splitbrain/​dokuwiki/​issues]]. You will need a free GitHub account to do so. Please **do not** report bugs anywhere else (IRC, Twitter, Forum). The Bug Tracker at GitHub is the only canonical way to report a bug. Again: report plugin bugs in the plugin's bug tracker. 
 + 
 +When reporting a bug you should try to include as much information as possible that helps developers with identifying the problem. 
 + 
 +This can include: 
 + 
 +  * DokuWiki version 
 +  * Operating system of the server and client 
 +  * The used web server 
 +  * The used PHP version 
 +  * The used browsers (try multiple) 
 +  * Everything that's special about your setup (plugins, auth backends, weird network config, etc.) 
 +  * Exact steps to reproduce the problem 
 +  * Screenshots 
 +  * What did you try to fix the problem and what where the exact results? 
 + 
 +It is especially important to gather exact error messages! See if you can find error logs from the web server and the JavaScript console (see below). 
 + 
 +Please also read [[http://​www.chiark.greenend.org.uk/​~sgtatham/​bugs.html|How to Report Bugs Effectively]] for more tips on submitting useful ​bug reports. 
 + 
 +===== How to obtain additional info ===== 
 + 
 +As mentioned above, DokuWiki developers need detailed error messages to debug a problem. Sometimes those are printed directly to the screen, but sometimes they aren'​t. In those cases you might want to check the following options: 
 + 
 +==== Server/PHP Error Logs ==== 
 + 
 +Whenever something goes fatally wrong, PHP will just stop processing your requestThis usually results in a [[faq:​blankpage|blank or partially rendered page]]. Sometimes errors are less grave but things are still missing. 
 + 
 +In all of those cases PHP will log an error message to some log file. Where exactly that log file resides is different from system ​to system. Errors might be logged to the web server'​s error log, the system global log or a specific PHP error log. This is configured in the [[phpfn>​error_log]] directive in php.ini. 
 + 
 +Typical locations are: 
 + 
 +  * ''/​var/​log/​apache2/​error.log''​ 
 +  * ''/​var/​log/​apache/​error.log''​ 
 +  * ''/​var/​log/​httpd/​error.log''​ 
 +  * ''/​var/​log/​syslog''​ 
 + 
 +If you are on a hosted server, best ask your provider where to find that log.  If you don't have access to ''​php.ini''​ and can't find the log file you could also try adding the following to the ''​.htaccess''​ file in your DokuWiki root folder: 
 + 
 +<​code>​ 
 +php_value display_errors 1 
 +php_value display_startup_errors 1 
 +</​code>​ 
 + 
 +That may send the error message to the browser. 
 + 
 +==== JavaScript Console log ==== 
 + 
 +Sometimes things go wrong on the client side (inside your browser). To figure out what, you will need to access the JavaScript console of your browser. To do so use the following keyboard shortcuts:​ 
 + 
 +^ Browser ^ Windows/​Linux ​               ^ Mac                       ^ 
 +| Chrome ​ | ''​Ctrl''​ + ''​Shift''​ + ''​J''​ | ''​Cmd''​ + ''​Opt''​ + ''​J''​ | 
 +| Firefox | ''​Ctrl''​ + ''​Shift''​ + ''​K''​ | ''​Cmd''​ + ''​Opt''​ + ''​K''​ | 
 +| Internet Explorer | ''​F12'',​ then click on the “Console” tab      || 
 +| Safari ​ |                              | ''​Cmd''​ + ''​Opt''​ + ''​C''​ | 
 + 
 +If you see any errors (usually shown in red) in the console, go to your [[plugin:​config|config manager]] and disable the [[config:​compress|“compress” setting]]. Reload the page and check the JavaScript console ​for errors again. 
 + 
 +If you find errors in the JavaScript console you should always attach them to your bug report. Preferably the ones found with the "​compress"​ setting disabled. However, sometimes errors only show up with "​compress enabled"​ --- in that case send us these error messages.
  
 ===== Recently opened tasks ===== ===== Recently opened tasks =====
  
-{{rss>http://bugs.splitbrain.org/feed.php?feed_type=rss2&project=1 1h}}+[[http://​feeds.feedburner.com/​dokuwiki-recently-opened-tasks|{{https://raw.githubusercontent.com/​legacy-icons/​famfamfam-silk/​master/​dist/​png/feed.png?16x16&​recache|Subscribe to ‘DokuWiki:​ Recently Opened Tasks’ by RSS}}]]  [[https://​feedburner.google.com/​fb/​a/​mailverify?​uri=dokuwiki-recently-opened-tasks&amp;loc=en_US|{{https://​raw.githubusercontent.com/​legacy-icons/​famfamfam-silk/​master/​dist/​png/​email.png?​16x16&​recache|Subscribe to ‘DokuWiki:​ Recently Opened Tasks’ by email}}]] 
 + 
 +{{rss>​http://​feeds.feedburner.com/​dokuwiki-recently-opened-tasks date author}} 
bugs.txt · Last modified: 2018-01-03 13:45 by andi