git.sesse.net Git - ffmpeg/blob - 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)://trac.ffmpeg.org
  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
  45 Priority:
  46 ---------
  47 critical
  48     Bugs and patches which deal with data loss and security issues.
  49     No feature request can be critical.
  50
  51 important
  52     Bugs which make FFmpeg unusable for a significant number of users, and
  53     patches fixing them.
  54     Examples here might be completely broken MPEG-4 decoding or a build issue
  55     on Linux.
  56     While broken 4xm decoding or a broken OS/2 build would not be important,
  57     the separation to normal is somewhat fuzzy.
  58     For feature requests this priority would be used for things many people
  59     want.
  60     Regressions also should be marked as important, regressions are bugs that
  61     don't exist in a past revision or another branch.
  62
  63 normal
  64
  65
  66 minor
  67     Bugs and patches about things like spelling errors, "mp2" instead of
  68     "mp3" being shown and such.
  69     Feature requests about things few people want or which do not make a big
  70     difference.
  71
  72 wish
  73     Something that is desirable to have but that there is no urgency at
  74     all to implement, e.g. something completely cosmetic like a website
  75     restyle or a personalized doxy template or the FFmpeg logo.
  76     This priority is not valid for bugs.
  77
  78
  79 Status:
  80 -------
  81 new
  82     initial state
  83
  84 open
  85     intermediate states
  86
  87 closed
  88     final state
  89
  90
  91 Analyzed flag:
  92 --------------
  93 Bugs which have been analyzed and where it is understood what causes them
  94 and which exact chain of events triggers them. This analysis should be
  95 available as a message in the bug report.
  96 Note, do not change the status to analyzed without also providing a clear
  97 and understandable analysis.
  98 This state implicates that the bug either has been reproduced or that
  99 reproduction is not needed as the bug is already understood.
 100
 101
 102 Type/Status:
 103 ----------
 104 */new
 105     Initial state of new bugs, patches and feature requests submitted by
 106     users.
 107
 108 */open
 109     Issues which have been briefly looked at and which did not look outright
 110     invalid.
 111     This implicates that no real more detailed state applies yet. Conversely,
 112     the more detailed states below implicate that the issue has been briefly
 113     looked at.
 114
 115 */closed/duplicate
 116     Bugs, patches or feature requests which are duplicates.
 117     Note that patches dealing with the same thing in a different way are not
 118     duplicates.
 119     Note, if you mark something as duplicate, do not forget setting the
 120     superseder so bug reports are properly linked.
 121
 122 */closed/invalid
 123     Bugs caused by user errors, random ineligible or otherwise nonsense stuff.
 124
 125 */closed/needs_more_info
 126     Issues for which some information has been requested by the developers,
 127     but which has not been provided by anyone within reasonable time.
 128
 129
 130 bug/closed/fixed
 131     Bugs which have to the best of our knowledge been fixed.
 132
 133 bug/closed/wont_fix
 134     Bugs which we will not fix. Possible reasons include legality, high
 135     complexity for the sake of supporting obscure corner cases, speed loss
 136     for similarly esoteric purposes, et cetera.
 137     This also means that we would reject a patch.
 138     If we are just too lazy to fix a bug then the correct state is open
 139     and unassigned. Closed means that the case is closed which is not
 140     the case if we are just waiting for a patch.
 141
 142 bug/closed/works_for_me
 143     Bugs for which sufficient information was provided to reproduce but
 144     reproduction failed - that is the code seems to work correctly to the
 145     best of our knowledge.
 146
 147 feature_request/closed/implemented
 148     Feature requests which have been implemented.
 149
 150 feature_request/closed/wont_implement
 151     Feature requests which will not be implemented. The reasons here could
 152     be legal, philosophical or others.
 153
 154 Note2, if you provide the requested info do not forget to remove the
 155 needs_more_info resolution.
 156
 157 Component:
 158 ----------
 159
 160 avcodec
 161     issues in libavcodec/*
 162
 163 avformat
 164     issues in libavformat/*
 165
 166 avutil
 167     issues in libavutil/*
 168
 169 regression test
 170     issues in tests/*
 171
 172 ffmpeg
 173     issues in or related to ffmpeg.c
 174
 175 ffplay
 176     issues in or related to ffplay.c
 177
 178 ffprobe
 179     issues in or related to ffprobe.c
 180
 181 ffserver
 182     issues in or related to ffserver.c
 183
 184 build system
 185     issues in or related to configure/Makefile
 186
 187 regression
 188     bugs which were not present in a past revision
 189
 190 trac
 191     issues related to our issue tracker