Merge branch 'master' of https://github.com/guoanwu/fio
[fio.git] / REPORTING-BUGS
1 Reporting a bug
2 ---------------
3
4 ...via the mailing list
5 =======================
6
7 If you notice anything that seems like a fio bug or want to ask fio related
8 questions, please send a plain-text only email to the list
9 (fio@vger.kernel.org, see README) about it. If you are not running the newest
10 release of fio please upgrade first.
11
12 When reporting a bug, you'll need to include:
13
14 1) A description of what you think the bug is
15 2) Environment (e.g. Linux distro version, kernel version). This is mostly
16    needed if it's a build bug.
17 3) The output from fio --version .
18 4) How to reproduce. Please include a full list of the parameters
19    passed to fio and the job file used (if any).
20
21 A bug report can't have too much information. Any time information that
22 is left out and has to be asked for will add to the turn-around time
23 of getting to the bottom of the issue, and an eventual fix.
24
25 That's it!
26
27 ...via GitHub issues
28 ====================
29
30 Please create an issue in the GitHub issue tracker
31 (https://github.com/axboe/fio/issues ) but observe the following:
32
33 a) If you are asking a question on how to do something ("How do I/Why is?")
34    please send it to the mailing list and not GitHub issues. The fio project
35    uses GitHub issues for reproducible bugs/enhancement requests.
36 b) Please reproduce your bug using the latest fio listed on
37    https://github.com/axboe/fio/releases (see the Source and Building sections
38    of the README for how to build fio from source).
39 c) Include all of the information requested in the mailing list section above
40    (description, environment, version, reproduction steps and all job parameters).
41
42 Thanks!