doc/issue_tracker.txt

   1 FFmpeg's bug/patch/feature request tracker manual
   2 =================================================
   3
   4 NOTE: This is a draft.
   5
   6 Overview:
   7 ---------
   8
   9 FFmpeg uses Trac for tracking issues, new issues and changes to
  10 existing issues can be done through a web interface.
  11
  12 Issues can be different kinds of things we want to keep track of
  13 but that do not belong into the source tree itself. This includes
  14 bug reports, patches, feature requests and license violations. We
  15 might add more items to this list in the future, so feel free to
  16 propose a new `type of issue' on the ffmpeg-devel mailing list if
  17 you feel it is worth tracking.
  18
  19 It is possible to subscribe to individual issues by adding yourself to the
  20 Cc list or to subscribe to the ffmpeg-trac mailing list which receives
  21 a mail for every change to every issue.
  22 (the above does all work already after light testing)
  23
  24 The subscription URL for the ffmpeg-trac list is:
  25 http(s)://ffmpeg.org/mailman/listinfo/ffmpeg-trac
  26 The URL of the webinterface of the tracker is:
  27 http(s)://ffmpeg.org/trac/ffmpeg
  28
  29 Type:
  30 -----
  31 bug / defect
  32     An error, flaw, mistake, failure, or fault in FFmpeg or libav* that
  33     prevents it from behaving as intended.
  34
  35 feature request / enhancement
  36     Request of support for encoding or decoding of a new codec, container
  37     or variant.
  38     Request of support for more, less or plain different output or behavior
  39     where the current implementation cannot be considered wrong.
  40
  41 license violation
  42     ticket to keep track of (L)GPL violations of ffmpeg by others
  43
  44 patch
  45     A patch as generated by diff which conforms to the patch submission and
  46     development policy.
  47
  48
  49 Priority:
  50 ---------
  51 critical
  52     Bugs and patches which deal with data loss and security issues.
  53     No feature request can be critical.
  54
  55 important
  56     Bugs which make FFmpeg unusable for a significant number of users, and
  57     patches fixing them.
  58     Examples here might be completely broken MPEG-4 decoding or a build issue
  59     on Linux.
  60     While broken 4xm decoding or a broken OS/2 build would not be important,
  61     the separation to normal is somewhat fuzzy.
  62     For feature requests this priority would be used for things many people
  63     want.
  64     Regressions also should be marked as important, regressions are bugs that
  65     don't exist in a past revision or another branch.
  66
  67 normal
  68
  69
  70 minor
  71     Bugs and patches about things like spelling errors, "mp2" instead of
  72     "mp3" being shown and such.
  73     Feature requests about things few people want or which do not make a big
  74     difference.
  75
  76 wish
  77     Something that is desirable to have but that there is no urgency at
  78     all to implement, e.g. something completely cosmetic like a website
  79     restyle or a personalized doxy template or the FFmpeg logo.
  80     This priority is not valid for bugs.
  81
  82
  83 Status:
  84 -------
  85 new
  86     initial state
  87
  88 open
  89     intermediate states
  90
  91 closed
  92     final state
  93
  94
  95 Analyzed flag:
  96 --------------
  97 Bugs which have been analyzed and where it is understood what causes them
  98 and which exact chain of events triggers them. This analysis should be
  99 available as a message in the bug report.
 100 Note, do not change the status to analyzed without also providing a clear
 101 and understandable analysis.
 102 This state implicates that the bug either has been reproduced or that
 103 reproduction is not needed as the bug is already understood.
 104
 105
 106 Type/Status/Substatus:
 107 ----------
 108 */new/new
 109     Initial state of new bugs, patches and feature requests submitted by
 110     users.
 111
 112 */open/open
 113     Issues which have been briefly looked at and which did not look outright
 114     invalid.
 115     This implicates that no real more detailed state applies yet. Conversely,
 116     the more detailed states below implicate that the issue has been briefly
 117     looked at.
 118
 119 */closed/duplicate
 120     Bugs, patches or feature requests which are duplicates.
 121     Note that patches dealing with the same thing in a different way are not
 122     duplicates.
 123     Note, if you mark something as duplicate, do not forget setting the
 124     superseder so bug reports are properly linked.
 125
 126 */closed/invalid
 127     Bugs caused by user errors, random ineligible or otherwise nonsense stuff.
 128
 129 */closed/needs_more_info
 130     Issues for which some information has been requested by the developers,
 131     but which has not been provided by anyone within reasonable time.
 132
 133
 134 bug/closed/fixed
 135     Bugs which have to the best of our knowledge been fixed.
 136
 137 bug/closed/wont_fix
 138     Bugs which we will not fix. Possible reasons include legality, high
 139     complexity for the sake of supporting obscure corner cases, speed loss
 140     for similarly esoteric purposes, et cetera.
 141     This also means that we would reject a patch.
 142     If we are just too lazy to fix a bug then the correct state is open
 143     and unassigned. Closed means that the case is closed which is not
 144     the case if we are just waiting for a patch.
 145
 146 bug/closed/works_for_me
 147     Bugs for which sufficient information was provided to reproduce but
 148     reproduction failed - that is the code seems to work correctly to the
 149     best of our knowledge.
 150
 151 patch/open/approved
 152     Patches which have been reviewed and approved by a developer.
 153     Such patches can be applied anytime by any other developer after some
 154     reasonable testing (compile + regression tests + does the patch do
 155     what the author claimed).
 156
 157 patch/open/needs_changes
 158     Patches which have been reviewed and need changes to be accepted.
 159
 160 patch/closed/applied
 161     Patches which have been applied.
 162
 163 patch/closed/rejected
 164     Patches which have been rejected.
 165
 166 feature_request/closed/implemented
 167     Feature requests which have been implemented.
 168
 169 feature_request/closed/wont_implement
 170     Feature requests which will not be implemented. The reasons here could
 171     be legal, philosophical or others.
 172
 173 Note, please do not use type-status-substatus combinations other than the
 174 above without asking on ffmpeg-dev first!
 175
 176 Note2, if you provide the requested info do not forget to remove the
 177 needs_more_info substatus.
 178
 179 Component:
 180 ----------
 181
 182 avcodec
 183     issues in libavcodec/*
 184
 185 avformat
 186     issues in libavformat/*
 187
 188 avutil
 189     issues in libavutil/*
 190
 191 regression test
 192     issues in tests/*
 193
 194 ffmpeg
 195     issues in or related to ffmpeg.c
 196
 197 ffplay
 198     issues in or related to ffplay.c
 199
 200 ffprobe
 201     issues in or related to ffprobe.c
 202
 203 ffserver
 204     issues in or related to ffserver.c
 205
 206 build system
 207     issues in or related to configure/Makefile
 208
 209 regression
 210     bugs which were not present in a past revision
 211
 212 trac
 213     issues related to our issue tracker