git.cworth.org Git - apitrace/blob - BUGS.markdown

   1 Reporting bugs
   2 ==============
   3
   4 Please report any issues on
   5 [github](https://github.com/apitrace/apitrace/issues).
   6
   7 Always include the following information:
   8
   9 * operating system name and version
  10
  11 * OpenGL/D3D driver name and version
  12
  13
  14 Proprietary/confidential applications
  15 =====================================
  16
  17 Issues should be preferably filed on github to facilitate collaborative
  18 development and for future reference.
  19
  20 Access to applications source code is not required -- binaries are sufficient.
  21
  22 If the bug happens with a proprietary application, and you don't want to
  23 publicly release the application and/or any data collected from it, then
  24 alternatively you can provide the necessary application and/or data via e-mail,
  25 to *jose dot r dot fonseca at gmail dot com*.
  26
  27 If it is not technically/legally feasible for you to provide application and/or
  28 data at all, then you must be either:
  29
  30 * develop and provide a test application, stripped-down of all
  31   proprietary/confidential data, but that can reproduce the issue;
  32
  33 * be willing/able to do the investigation of the issue, namely to identify the
  34   root cause of the issue (e.g., which OpenGL call is not properly handled and
  35   why), using all necessary tools (such as debuggers).
  36
  37 Failure to do so will render the apitrace authors powerless to address the
  38 issue.
  39
  40
  41 Attachments
  42 ===========
  43
  44 github issue tracker doesn't support attachments.
  45
  46 Please attach long logs to https://gist.github.com/ and paste the URL into the
  47 issue description.
  48
  49 For big attachments, such as traces, please upload it temporarily to a web
  50 server you control, or use a file upload service such as
  51 http://www.megaupload.com/ or http://dropbox.com/ and paste the URL into the
  52 issue description.
  53
  54 Trace files are only slightly compressed (for performance reasons).  You can
  55 further reduce their size when attaching/uploading by compressing with
  56 [XZ](http://tukaani.org/xz/) or [7-Zip](http://www.7-zip.org/).
  57
  58
  59 Bugs on tracing
  60 ===============
  61
  62 For bugs that happen while tracing (e.g., crashes while tracing the
  63 application, or incorrect traces) please:
  64
  65 * provide information on how to obtain the application;
  66
  67 * describe how you were using it when the issue happened.
  68
  69
  70 Bugs on retracing/GUI
  71 =====================
  72
  73 For bugs on retracing (e.g. crashes when retracing the application,
  74 incorrect inconsistent rendering, or viewing with the GUI) please:
  75
  76 * provide the trace file;
  77
  78 * describe the results you got, and what results you were expecting.
  79
  80
  81 Obtaining stack back-traces
  82 ===========================
  83
  84
  85 Linux/MacOSX
  86 ------------
  87
  88 Please rebuild apitrace with debugging information, by passing
  89 `-DCMAKE_BUILD_TYPE=Debug` to cmake.
  90
  91 To obtain a stack back-trace, run the application with gdb from a terminal:
  92
  93     $ gdb --args application arg1 arg2 ...
  94     (gdb) run
  95     ...
  96     (gdb) bt
  97
  98
  99 See also more detailed and Distro specific instructions:
 100
 101 * http://wiki.debian.org/HowToGetABacktrace
 102
 103 * https://wiki.ubuntu.com/Backtrace
 104
 105 * http://fedoraproject.org/wiki/StackTraces
 106
 107 * http://live.gnome.org/GettingTraces
 108
 109
 110 Windows
 111 -------
 112
 113 WRITEME
 114
 115