2014-01-23 01:15:31 +00:00
|
|
|
# Bug reporting
|
|
|
|
|
|
|
|
|
|
First and foremost, see `README.md` and other documentation in `doc`.
|
2014-02-06 11:27:39 +00:00
|
|
|
Although the documentation might be outdated, a lot of it is still
|
|
|
|
|
relevant.
|
2014-01-23 01:15:31 +00:00
|
|
|
|
|
|
|
|
The [issue tracker](https://github.com/veox/sgminer/issues) is there
|
|
|
|
|
specifically for reporting bugs, issues and proposed improvements. Other
|
2014-02-06 11:27:39 +00:00
|
|
|
communication channels are not necessarily monitored.
|
2014-01-23 01:15:31 +00:00
|
|
|
|
|
|
|
|
Search the issue list to see if it has already been reported.
|
|
|
|
|
|
2014-02-06 11:27:39 +00:00
|
|
|
Information that may be relevant, depending on the nature of your issue:
|
2014-01-23 01:15:31 +00:00
|
|
|
|
|
|
|
|
* OS version;
|
|
|
|
|
* Catalyst driver version;
|
|
|
|
|
* AMD APP SDK version;
|
|
|
|
|
* AMD ADL version;
|
|
|
|
|
* GPUs used (`sgminer --ndevs`);
|
2014-02-06 11:27:39 +00:00
|
|
|
* whether you're using a pre-compiled binary or built from source;
|
2014-01-31 20:00:41 +00:00
|
|
|
* `sgminer` version (`sgminer --version` and/or `git describe`);
|
2014-01-23 01:15:31 +00:00
|
|
|
* contents of the configuration file;
|
|
|
|
|
* launch procedure (manual or via script);
|
|
|
|
|
* steps to repeat;
|
|
|
|
|
* expected result;
|
|
|
|
|
* actual result;
|
|
|
|
|
* debug output (`sgminer --text-only --debug --verbose`).
|
|
|
|
|
|
2014-02-06 12:48:53 +00:00
|
|
|
If there is a need to provide more than a screenfull of log
|
|
|
|
|
data, it is preferred that a link is given instead. Try
|
|
|
|
|
[gist](https://gist.github.com).
|
