Statistics
| Branch: | Revision:

ffmpeg / doc / issue_tracker.txt @ 8787d837

History | View | Annotate | Download (6.82 KB)

1
FFmpeg's 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
be properly 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 the top level
20
domain of Hungary to the tracker, and of Italy to the mailing list.
21

    
22
Email Interface:
23
----------------
24
There is a mailing list to which all new issues and changes to existing issues
25
are sent. 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 mailing list.
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 implementation 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 MPEG-4 decoding or a build issue
65
    on Linux.
66
    While broken 4xm decoding or a broken OS/2 build would not be important,
67
    the 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 website
83
    restyle or a personalized doxy template or the FFmpeg logo.
84
    This priority is not 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. Conversely,
109
    the 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 duplicates.
114
    Note that patches dealing with the same thing in a different way are not
115
    duplicates.
116
    Note, if you mark something as duplicate, do not forget setting the
117
    superseder so bug reports are properly linked.
118

    
119
*/closed/invalid
120
    Bugs caused by user errors, random ineligible or otherwise nonsense stuff.
121

    
122
bug/open/reproduced
123
    Bugs which have been reproduced.
124

    
125
bug/open/analyzed
126
    Bugs which have been analyzed and where it is understood what causes them
127
    and which exact chain of events triggers them. This analysis should be
128
    available as a message in the bug report.
129
    Note, do not change the status to analyzed without also providing a clear
130
    and understandable analysis.
131
    This state implicates that the bug either has been reproduced or that
132
    reproduction is not needed as the bug is already understood.
133

    
134
bug/open/needs_more_info
135
    Bug reports which are incomplete and or where more information is needed
136
    from the submitter or another person who can provide it.
137
    This state implicates that the bug has not been analyzed or reproduced.
138
    Note, the idea behind needs_more_info is to offload work from the
139
    developers to the users whenever possible.
140

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

    
144
bug/closed/wont_fix
145
    Bugs which we will not fix, the reasons here could be legal, philosophical
146
    or others.
147

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

    
153
patch/open/approved
154
    Patches which have been reviewed and approved by a developer.
155
    Such patches can be applied anytime by any other developer after some
156
    reasonable testing (compile + regression tests + does the patch do
157
    what the author claimed).
158

    
159
patch/open/needs_changes
160
    Patches which have been reviewed and need changes to be accepted.
161

    
162
patch/closed/applied
163
    Patches which have been applied.
164

    
165
patch/closed/rejected
166
    Patches which have been rejected.
167

    
168
feature_request/open/needs_more_info
169
    Feature requests where it is not clear what exactly is wanted
170
    (these also could be closed as invalid ...).
171

    
172
feature_request/closed/implemented
173
    Feature requests which have been implemented.
174

    
175
feature_request/closed/wont_implement
176
    Feature requests which will not be implemented. The reasons here could
177
    be legal, philosophical or others.
178

    
179
Note, please do not use type-status-substatus combinations other than the
180
above without asking on ffmpeg-dev first!
181

    
182
Note2, if you provide the requested info do not forget to remove the
183
needs_more_info substate.
184

    
185
Topic:
186
------
187
A topic is a tag you should add to your issue in order to make grouping them
188
easier.
189

    
190
avcodec
191
    issues in libavcodec/*
192

    
193
avformat
194
    issues in libavformat/*
195

    
196
avutil
197
    issues in libavutil/*
198

    
199
regression test
200
    issues in tests/*
201

    
202
ffmpeg
203
    issues in or related to ffmpeg.c
204

    
205
ffplay
206
    issues in or related to ffplay.c
207

    
208
ffserver
209
    issues in or related to ffserver.c
210

    
211
build system
212
    issues in or related to configure/Makefile
213

    
214
regression
215
    bugs which were working in a past revision
216

    
217
roundup
218
    issues related to our issue tracker