doc/issue_tracker.txt

   1 ffmpegs bug/patch/feature request tracker manual
   2 ================================================
   3
   4 NOTE, this is a draft, it is not yet recommended to send real bugreports to the
   5 tracker but rather use the mailing lists.
   6 Though, if you are brave and do not mind that your bugreport might disappear or
   7 that you might be mailbombed due to a misconfiguration, you can surely try
   8 to enter a real bugreport.
   9
  10 Overview:
  11 ---------
  12 FFmpeg uses roundup for tracking issues, new issues and changes to
  13 existing issues can be done through a web interface and through email.
  14 It is possible to subscribe to individual issues by adding yourself to the
  15 nosy list or to subscribe to the ffmpeg-issues mailing list which receives
  16 a mail for every change to every issue. Replies to such mails will also
  17 properly be added to the respective issue.
  18 (the above does all work already after light testing)
  19
  20 note: issue = (bug report || patch || feature request)
  21
  22 Type:
  23 -----
  24 bug
  25     An error, flaw, mistake, failure, or fault in ffmpeg or libav* that
  26     prevents it from behaving as intended.
  27
  28 feature request
  29     Request of support for encoding or decoding of a new codec, container
  30     or variant.
  31     Request of support for more, less or plain different output or behavior
  32     where the current behavior cannot be considered wrong.
  33
  34 patch
  35     A patch as generated by diff which conforms to the patch submission and
  36     Development Policy.
  37
  38
  39 Priority:
  40 ---------
  41 critical
  42     Bugs and patches which deal with data loss and security issues.
  43     No feature request can be critical.
  44
  45 important
  46     Bugs which make ffmpeg unusable for a significant number of users, and
  47     patches fixing them.
  48     Examples here might be completely broken mpeg4 decoding or a build issue
  49     on Linux.
  50     While broken 4xm decoding or broken OS/2 build would not be important, the
  51     separation to normal is somewhat fuzzy ...
  52     For feature requests this priority would be used for things many people
  53     want.
  54
  55 normal
  56
  57
  58 minor
  59     Bugs and patches about things like spelling errors, "mp2" instead of
  60     "mp3" being shown and such.
  61     Feature requests about things few people want or which do not make a big
  62     difference.
  63
  64 wish
  65     Something that is desirable to have but that there is no urgency at
  66     all to implement, e.g.: something completely cosmetic like a
  67     website restyle or a personalized doxy template or the ffmpeg logo.
  68     This priority isn't valid for bugs.
  69
  70
  71 Status:
  72 -------
  73 new
  74     initial state
  75
  76 open
  77     intermediate states
  78
  79 closed
  80     Final state
  81
  82
  83 Type/Status/Substatus:
  84 ----------
  85 */new/new
  86     Initial state of new bugs, patches and feature requests submitted by
  87     users
  88
  89 */open/open
  90     Issues which have been briefly looked at and which did not look outright
  91     invalid.
  92     This implicates that no real more detailed state applies yet. And the
  93     more detailed states below implicate that the issue has been briefly
  94     looked at.
  95
  96 */closed/duplicate
  97     Bugs, patches or feature requests which are duplicate of some other.
  98     Note patches dealing with the same thing but differently are not duplicate.
  99
 100 */closed/invalid
 101     Bugs caused by user errors, random ineligible or otherwise nonsense stuff
 102
 103 bug/open/reproduced
 104     Bugs which have been reproduced
 105
 106 bug/open/analyzed
 107     Bugs which have been analyzed and where it is understood what causes them
 108     and which exact chain of events triggers them. This analysis should be
 109     available as a message in the bugreport.
 110     Note, do not change the status to analyzed without also providing a clear
 111     and understandable analysis.
 112     This state implicates that the bug either has been reproduced or that
 113     reproduction is not needed as the bug is understood already anyway.
 114
 115 bug/open/needs_more_info
 116     Bugreports which are incomplete and or where more information is needed
 117     from the submitter or another person who can provide the info.
 118     This state implicates that the bug has not been analyzed or reproduced.
 119
 120 bug/closed/fixed
 121     Bugs which have to the best of our knowledge been fixed.
 122
 123 bug/closed/wont_fix
 124     Bugs which we will not fix, the reasons here could be legal, philosophical
 125     or others.
 126
 127 bug/closed/works_for_me
 128     Bugs for which sufficient information was provided to reproduce but
 129     reproduction failed - that is the code seems to work correctly to the
 130     best of our knowledge.
 131
 132 patch/open/approved
 133     Patches which have been reviewed and approved by a developer.
 134     Such patches can be applied anytime by any other developer after some
 135     reasonable testing (compile + regression tests + does the patch do
 136     what the author claimed).
 137
 138 patch/open/needs_changes
 139     Patches which have been reviewed and need changes to be accepted.
 140
 141 patch/closed/applied
 142     Patches which have been applied.
 143
 144 patch/closed/rejected
 145     Patches which have been rejected.
 146
 147 feature_request/open/needs_more_info
 148     Feature requests where its not clear what exactly is wanted
 149     (these also could be closed as invalid ...).
 150
 151 feature_request/closed/implemented
 152     Feature requests which have been implemented.
 153
 154 feature_request/closed/wont_implement
 155     Feature requests which will not be implemented. The reasons here could
 156     be legal, philosophical or others.
 157
 158 Note, please do not use type-status-substatus combinations other than the
 159 above without asking on ffmpeg-dev first!