issue_tracker.txt 5.61 KB
Newer Older
1
FFmpeg's bug/feature request tracker manual
2
=================================================
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
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
14
bug reports, feature requests and license violations. We
15 16 17 18
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
The subscription URL for the ffmpeg-trac list is:
25
http(s)://lists.ffmpeg.org/mailman/listinfo/ffmpeg-trac
26
The URL of the webinterface of the tracker is:
27
http(s)://trac.ffmpeg.org
28 29 30

Type:
-----
31 32 33
art
    Artwork such as photos, music, banners, and logos.

34
bug / defect
Diego Biurrun's avatar
Diego Biurrun committed
35
    An error, flaw, mistake, failure, or fault in FFmpeg or libav* that
36 37
    prevents it from behaving as intended.

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

44 45 46
license violation
    ticket to keep track of (L)GPL violations of ffmpeg by others

47 48 49
sponsoring request
    Developer requests for hardware, software, specifications, money,
    refunds, etc.
50 51 52 53

Priority:
---------
critical
54
    Bugs about data loss and security issues.
55
    No feature request can be critical.
56 57

important
58
    Bugs which make FFmpeg unusable for a significant number of users.
Diego Biurrun's avatar
Diego Biurrun committed
59
    Examples here might be completely broken MPEG-4 decoding or a build issue
60
    on Linux.
Diego Biurrun's avatar
Diego Biurrun committed
61 62
    While broken 4xm decoding or a broken OS/2 build would not be important,
    the separation to normal is somewhat fuzzy.
63 64
    For feature requests this priority would be used for things many people
    want.
65
    Regressions also should be marked as important, regressions are bugs that
66
    don't exist in a past revision or another branch.
67 68 69 70 71

normal


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

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


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

open
    intermediate states

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


96 97 98 99 100 101 102 103 104 105 106
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.


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

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

*/closed/duplicate
121
    Bugs or feature requests which are duplicates.
Diego Biurrun's avatar
Diego Biurrun committed
122 123
    Note, if you mark something as duplicate, do not forget setting the
    superseder so bug reports are properly linked.
124 125

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

128 129 130 131
*/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.

132 133 134 135

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

136
bug/closed/wontfix
137 138 139
    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.
140
    This also means that we would reject a patch.
141
    If we are just too lazy to fix a bug then the correct state is open
142 143
    and unassigned. Closed means that the case is closed which is not
    the case if we are just waiting for a patch.
144 145 146

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

150
feature_request/closed/fixed
151 152
    Feature requests which have been implemented.

153
feature_request/closed/wontfix
Luca Barbato's avatar
Luca Barbato committed
154
    Feature requests which will not be implemented. The reasons here could
155 156
    be legal, philosophical or others.

Diego Biurrun's avatar
Diego Biurrun committed
157
Note2, if you provide the requested info do not forget to remove the
158
needs_more_info resolution.
159

160 161
Component:
----------
Michael Niedermayer's avatar
Michael Niedermayer committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180

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

181 182 183
ffprobe
    issues in or related to ffprobe.c

Michael Niedermayer's avatar
Michael Niedermayer committed
184 185 186 187 188 189 190
ffserver
    issues in or related to ffserver.c

build system
    issues in or related to configure/Makefile

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

193
trac
Michael Niedermayer's avatar
Michael Niedermayer committed
194
    issues related to our issue tracker