issue_tracker.txt 6.35 KB
Newer Older
1 2
FFmpeg's bug/patch/feature request tracker manual
=================================================
3

Diego Biurrun's avatar
Diego Biurrun committed
4
NOTE: This is a draft.
5 6 7

Overview:
---------
8

9 10
FFmpeg uses Trac for tracking issues, new issues and changes to
existing issues can be done through a web interface.
11

12 13 14 15 16 17 18
Issues can be different kinds of things we want to keep track of
but that do not belong into the source tree itself. This includes
bug reports, patches, feature requests and license violations. We
might add more items to this list in the future, so feel free to
propose a new `type of issue' on the ffmpeg-devel mailing list if
you feel it is worth tracking.

19
It is possible to subscribe to individual issues by adding yourself to the
20 21
Cc list or to subscribe to the ffmpeg-trac mailing list which receives
a mail for every change to every issue.
22
(the above does all work already after light testing)
23

24 25
The subscription URL for the ffmpeg-trac list is:
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 30

Type:
-----
31
bug / defect
Diego Biurrun's avatar
Diego Biurrun committed
32
    An error, flaw, mistake, failure, or fault in FFmpeg or libav* that
33 34
    prevents it from behaving as intended.

35
feature request / enhancement
36 37
    Request of support for encoding or decoding of a new codec, container
    or variant.
38
    Request of support for more, less or plain different output or behavior
Diego Biurrun's avatar
Diego Biurrun committed
39
    where the current implementation cannot be considered wrong.
40

41 42 43
license violation
    ticket to keep track of (L)GPL violations of ffmpeg by others

44 45
patch
    A patch as generated by diff which conforms to the patch submission and
Diego Biurrun's avatar
Diego Biurrun committed
46
    development policy.
47 48 49 50 51


Priority:
---------
critical
52 53
    Bugs and patches which deal with data loss and security issues.
    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.
Diego Biurrun's avatar
Diego Biurrun committed
58
    Examples here might be completely broken MPEG-4 decoding or a build issue
59
    on Linux.
Diego Biurrun's avatar
Diego Biurrun committed
60 61
    While broken 4xm decoding or a broken OS/2 build would not be important,
    the separation to normal is somewhat fuzzy.
62 63
    For feature requests this priority would be used for things many people
    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 68 69 70 71

normal


minor
    Bugs and patches about things like spelling errors, "mp2" instead of
72 73
    "mp3" being shown and such.
    Feature requests about things few people want or which do not make a big
74 75 76
    difference.

wish
Luca Barbato's avatar
Luca Barbato committed
77
    Something that is desirable to have but that there is no urgency at
Diego Biurrun's avatar
Diego Biurrun committed
78
    all to implement, e.g. something completely cosmetic like a website
79
    restyle or a personalized doxy template or the FFmpeg logo.
Diego Biurrun's avatar
Diego Biurrun committed
80
    This priority is not valid for bugs.
81 82 83 84 85 86 87 88 89 90 91


Status:
-------
new
    initial state

open
    intermediate states

closed
Diego Biurrun's avatar
Diego Biurrun committed
92
    final state
93 94


95 96 97 98 99 100 101 102 103 104 105
Analyzed flag:
--------------
Bugs which have been analyzed and where it is understood what causes them
and which exact chain of events triggers them. This analysis should be
available as a message in the bug report.
Note, do not change the status to analyzed without also providing a clear
and understandable analysis.
This state implicates that the bug either has been reproduced or that
reproduction is not needed as the bug is already understood.


106 107 108 109
Type/Status/Substatus:
----------
*/new/new
    Initial state of new bugs, patches and feature requests submitted by
Diego Biurrun's avatar
Diego Biurrun committed
110
    users.
111 112

*/open/open
113 114
    Issues which have been briefly looked at and which did not look outright
    invalid.
Diego Biurrun's avatar
Diego Biurrun committed
115 116
    This implicates that no real more detailed state applies yet. Conversely,
    the more detailed states below implicate that the issue has been briefly
117 118 119
    looked at.

*/closed/duplicate
Diego Biurrun's avatar
Diego Biurrun committed
120 121 122
    Bugs, patches or feature requests which are duplicates.
    Note that patches dealing with the same thing in a different way are not
    duplicates.
Diego Biurrun's avatar
Diego Biurrun committed
123 124
    Note, if you mark something as duplicate, do not forget setting the
    superseder so bug reports are properly linked.
125 126

*/closed/invalid
Diego Biurrun's avatar
Diego Biurrun committed
127
    Bugs caused by user errors, random ineligible or otherwise nonsense stuff.
128

129 130 131 132
*/closed/needs_more_info
    Issues for which some information has been requested by the developers,
    but which has not been provided by anyone within reasonable time.

133 134 135 136 137

bug/closed/fixed
    Bugs which have to the best of our knowledge been fixed.

bug/closed/wont_fix
138 139 140
    Bugs which we will not fix. Possible reasons include legality, high
    complexity for the sake of supporting obscure corner cases, speed loss
    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 144
    and unassigned. Closed means that the case is closed which is not
    the case if we are just waiting for a patch.
145 146 147

bug/closed/works_for_me
    Bugs for which sufficient information was provided to reproduce but
148
    reproduction failed - that is the code seems to work correctly to the
Luca Barbato's avatar
Luca Barbato committed
149
    best of our knowledge.
150 151 152 153 154

patch/open/approved
    Patches which have been reviewed and approved by a developer.
    Such patches can be applied anytime by any other developer after some
    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 167 168 169

feature_request/closed/implemented
    Feature requests which have been implemented.

feature_request/closed/wont_implement
Luca Barbato's avatar
Luca Barbato committed
170
    Feature requests which will not be implemented. The reasons here could
171 172 173
    be legal, philosophical or others.

Note, please do not use type-status-substatus combinations other than the
174
above without asking on ffmpeg-dev first!
Luca Barbato's avatar
Luca Barbato committed
175

Diego Biurrun's avatar
Diego Biurrun committed
176
Note2, if you provide the requested info do not forget to remove the
177
needs_more_info substatus.
178

179 180
Component:
----------
Michael Niedermayer's avatar
Michael Niedermayer committed
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199

avcodec
    issues in libavcodec/*

avformat
    issues in libavformat/*

avutil
    issues in libavutil/*

regression test
    issues in tests/*

ffmpeg
    issues in or related to ffmpeg.c

ffplay
    issues in or related to ffplay.c

200 201 202
ffprobe
    issues in or related to ffprobe.c

Michael Niedermayer's avatar
Michael Niedermayer committed
203 204 205 206 207 208 209
ffserver
    issues in or related to ffserver.c

build system
    issues in or related to configure/Makefile

regression
210
    bugs which were not present in a past revision
Michael Niedermayer's avatar
Michael Niedermayer committed
211

212
trac
Michael Niedermayer's avatar
Michael Niedermayer committed
213
    issues related to our issue tracker