| 1 | # Getting support for fio |
| 2 | |
| 3 | ## General questions |
| 4 | |
| 5 | Please use the fio mailing list for asking general fio questions (e.g. "How do |
| 6 | I do X?", "Why does Y happen?"). See the Mailing list section of the |
| 7 | [README][readme] for details). |
| 8 | |
| 9 | ## Reporting bugs |
| 10 | |
| 11 | As mentioned in [REPORTING-BUGS][reportingbugs], fio bugs and enhancements can |
| 12 | be reported to the fio mailing list or fio's GitHub issues tracker. |
| 13 | |
| 14 | When reporting bugs please include ALL of the following: |
| 15 | - Description of the issue |
| 16 | - fio version number tested. If your fio isn't among the recent releases (see |
| 17 | the [fio releases page][releases]) please build a new one from source (see |
| 18 | the Source and Building sections of the [README][readme] for how to do this) |
| 19 | and reproduce the issue with the fresh build before filing an issue. |
| 20 | - Reproduction steps and minimal job file/command line parameters. |
| 21 | |
| 22 | When requesting an enhancement only the description is needed. |
| 23 | |
| 24 | ### GitHub issues specific information |
| 25 | |
| 26 | [Formatting terminal output with markdown][quotingcode] will help people who |
| 27 | are reading your report. However, if the output is large (e.g. over 15 lines |
| 28 | long) please consider including it as a text attachment. Avoid attaching |
| 29 | pictures of screenshots as these are not searchable/selectable. |
| 30 | |
| 31 | <!-- Definitions --> |
| 32 | |
| 33 | [readme]: ../README |
| 34 | [reportingbugs]: ../REPORTING-BUGS |
| 35 | [releases]: ../../../releases |
| 36 | [quotingcode]: https://docs.github.com/en/free-pro-team@latest/github/writing-on-github/basic-writing-and-formatting-syntax#quoting-code |