X-Git-Url: https://git.kernel.dk/?p=fio.git;a=blobdiff_plain;f=REPORTING-BUGS;h=c0204d7e09be4acb68b71b53112fe82a8e179852;hp=d8876ae6870f691f0e5a777b398d71b19203937e;hb=a59b12d2a5eb92c1128a5d8ebcd03b1831962ce5;hpb=a4f581f981a2a0e19d22339d9fdf17b3aaeb12b8 diff --git a/REPORTING-BUGS b/REPORTING-BUGS index d8876ae6..c0204d7e 100644 --- a/REPORTING-BUGS +++ b/REPORTING-BUGS @@ -1,21 +1,42 @@ Reporting a bug --------------- -If you notice anything that seems like a fio bug, please do send email -to the list (fio@vger.kernel.org, see README) about it. If you are not -running the newest release of fio, upgrading first is recommended. +...via the mailing list +======================= + +If you notice anything that seems like a fio bug or want to ask fio related +questions, please send a plain-text only email to the list +(fio@vger.kernel.org, see README) about it. If you are not running the newest +release of fio please upgrade first. When reporting a bug, you'll need to include: 1) A description of what you think the bug is -2) Environment (Linux distro version, kernel version). This is mostly +2) Environment (e.g. Linux distro version, kernel version). This is mostly needed if it's a build bug. -3) The output from fio --version. +3) The output from fio --version . 4) How to reproduce. Please include a full list of the parameters passed to fio and the job file used (if any). -A bug report can never have too much information. Any time information -is left out and has to be asked for, it'll add to the turn-around time -of getting to the bottom of it and committing a fix. +A bug report can't have too much information. Any time information that +is left out and has to be asked for will add to the turn-around time +of getting to the bottom of the issue, and an eventual fix. That's it! + +...via GitHub issues +==================== + +Please create an issue in the GitHub issue tracker +(https://github.com/axboe/fio/issues ) but observe the following: + +a) If you are asking a question on how to do something ("How do I/Why is?") + please send it to the mailing list and not GitHub issues. The fio project + uses GitHub issues for reproducible bugs/enhancement requests. +b) Please reproduce your bug using the latest fio listed on + https://github.com/axboe/fio/releases (see the Source and Building sections + of the README for how to build fio from source). +c) Include all of the information requested in the mailing list section above + (description, environment, version, reproduction steps and all job parameters). + +Thanks!