doc/issue_tracker.txt

   1 ffmpegs bug/patch/feature request tracker manual
   2 ================================================
   3
   4 NOTE, this is a draft
   5
   6 Overview:
   7 ---------
   8 FFmpeg uses roundup for tracking issues, new issues and changes to
   9 existing issues can be done through a web interface and through email.
  10 It is possible to subscribe to individual issues by adding yourself to the
  11 nosy list or to subscribe to the ffmpeg-issues mailing list which receives
  12 a mail for every change to every issue. Replies to such mails will also
  13 properly be added to the respective issue.
  14 (the above does all work already after light testing)
  15 The subscription URL for the ffmpeg-issues list is:
  16 http://live.polito/mailman/listinfo/ffmpeg-issues
  17 The URL of the webinterface of the tracker is:
  18 http(s)://roundup.mplayerhq/roundup/ffmpeg/
  19 Note the URLs in this document are obfuscated, you must append top level
  20 domain of hungary to the tracker, and italy to the mailinglist.
  21
  22 Email Interface:
  23 ----------------
  24 Theres a mailinglist to which all new issues and changes to existing issues
  25 are sent to, you can subscribe through
  26 http://live.polito/mailman/listinfo/ffmpeg-issues
  27 Replies to messages there will have their text added to the specific issues.
  28 Attachments will be added as if they had been uploaded via the web interface.
  29 You can change the status, substatus, topic, ... by changing the subject in
  30 your reply like:
  31 Re: [issue94] register_avcodec and allcodecs.h [type=patch;status=open;substatus=approved]
  32 roundup will then change things as you requested and remove the [...] from
  33 the subject before forwarding the mail to the mailinglist
  34
  35
  36 note: issue = (bug report || patch || feature request)
  37
  38 Type:
  39 -----
  40 bug
  41     An error, flaw, mistake, failure, or fault in ffmpeg or libav* that
  42     prevents it from behaving as intended.
  43
  44 feature request
  45     Request of support for encoding or decoding of a new codec, container
  46     or variant.
  47     Request of support for more, less or plain different output or behavior
  48     where the current behavior cannot be considered wrong.
  49
  50 patch
  51     A patch as generated by diff which conforms to the patch submission and
  52     Development Policy.
  53
  54
  55 Priority:
  56 ---------
  57 critical
  58     Bugs and patches which deal with data loss and security issues.
  59     No feature request can be critical.
  60
  61 important
  62     Bugs which make ffmpeg unusable for a significant number of users, and
  63     patches fixing them.
  64     Examples here might be completely broken mpeg4 decoding or a build issue
  65     on Linux.
  66     While broken 4xm decoding or broken OS/2 build would not be important, the
  67     separation to normal is somewhat fuzzy ...
  68     For feature requests this priority would be used for things many people
  69     want.
  70
  71 normal
  72
  73
  74 minor
  75     Bugs and patches about things like spelling errors, "mp2" instead of
  76     "mp3" being shown and such.
  77     Feature requests about things few people want or which do not make a big
  78     difference.
  79
  80 wish
  81     Something that is desirable to have but that there is no urgency at
  82     all to implement, e.g.: something completely cosmetic like a
  83     website restyle or a personalized doxy template or the ffmpeg logo.
  84     This priority isn't valid for bugs.
  85
  86
  87 Status:
  88 -------
  89 new
  90     initial state
  91
  92 open
  93     intermediate states
  94
  95 closed
  96     Final state
  97
  98
  99 Type/Status/Substatus:
 100 ----------
 101 */new/new
 102     Initial state of new bugs, patches and feature requests submitted by
 103     users
 104
 105 */open/open
 106     Issues which have been briefly looked at and which did not look outright
 107     invalid.
 108     This implicates that no real more detailed state applies yet. And the
 109     more detailed states below implicate that the issue has been briefly
 110     looked at.
 111
 112 */closed/duplicate
 113     Bugs, patches or feature requests which are duplicate of some other.
 114     Note patches dealing with the same thing but differently are not duplicate.
 115
 116 */closed/invalid
 117     Bugs caused by user errors, random ineligible or otherwise nonsense stuff
 118
 119 bug/open/reproduced
 120     Bugs which have been reproduced
 121
 122 bug/open/analyzed
 123     Bugs which have been analyzed and where it is understood what causes them
 124     and which exact chain of events triggers them. This analysis should be
 125     available as a message in the bugreport.
 126     Note, do not change the status to analyzed without also providing a clear
 127     and understandable analysis.
 128     This state implicates that the bug either has been reproduced or that
 129     reproduction is not needed as the bug is understood already anyway.
 130
 131 bug/open/needs_more_info
 132     Bugreports which are incomplete and or where more information is needed
 133     from the submitter or another person who can provide the info.
 134     This state implicates that the bug has not been analyzed or reproduced.
 135
 136 bug/closed/fixed
 137     Bugs which have to the best of our knowledge been fixed.
 138
 139 bug/closed/wont_fix
 140     Bugs which we will not fix, the reasons here could be legal, philosophical
 141     or others.
 142
 143 bug/closed/works_for_me
 144     Bugs for which sufficient information was provided to reproduce but
 145     reproduction failed - that is the code seems to work correctly to the
 146     best of our knowledge.
 147
 148 patch/open/approved
 149     Patches which have been reviewed and approved by a developer.
 150     Such patches can be applied anytime by any other developer after some
 151     reasonable testing (compile + regression tests + does the patch do
 152     what the author claimed).
 153
 154 patch/open/needs_changes
 155     Patches which have been reviewed and need changes to be accepted.
 156
 157 patch/closed/applied
 158     Patches which have been applied.
 159
 160 patch/closed/rejected
 161     Patches which have been rejected.
 162
 163 feature_request/open/needs_more_info
 164     Feature requests where its not clear what exactly is wanted
 165     (these also could be closed as invalid ...).
 166
 167 feature_request/closed/implemented
 168     Feature requests which have been implemented.
 169
 170 feature_request/closed/wont_implement
 171     Feature requests which will not be implemented. The reasons here could
 172     be legal, philosophical or others.
 173
 174 Note, please do not use type-status-substatus combinations other than the
 175 above without asking on ffmpeg-dev first!
 176
 177 Note2, if you provide the requested info dont forget to remove the
 178 needs_more_info substate
 179
 180 Topic:
 181 ------
 182 A topic is a tag you should add to your issue in order to make grouping them
 183 easier.
 184
 185 avcodec
 186     issues in libavcodec/*
 187
 188 avformat
 189     issues in libavformat/*
 190
 191 avutil
 192     issues in libavutil/*
 193
 194 regression test
 195     issues in tests/*
 196
 197 ffmpeg
 198     issues in or related to ffmpeg.c
 199
 200 ffplay
 201     issues in or related to ffplay.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 where working in a past revission
 211
 212 roundup
 213     issues related to our issue tracker