ARM: check for VFP register arguments
[libav.git] / doc / issue_tracker.txt
CommitLineData
208506e2
DB
1FFmpeg's bug/patch/feature request tracker manual
2=================================================
0c84e744 3
208506e2 4NOTE: This is a draft.
0c84e744
MN
5
6Overview:
7---------
208506e2 8FFmpeg uses Roundup for tracking issues, new issues and changes to
0c84e744 9existing issues can be done through a web interface and through email.
d6d0182e 10It is possible to subscribe to individual issues by adding yourself to the
57492dfe 11nosy list or to subscribe to the ffmpeg-issues mailing list which receives
0c84e744 12a mail for every change to every issue. Replies to such mails will also
208506e2 13be properly added to the respective issue.
0c84e744 14(the above does all work already after light testing)
07c5445d 15The subscription URL for the ffmpeg-issues list is:
2f4d5971 16http://live.polito/mailman/listinfo/ffmpeg-issues
80c24d99 17The URL of the webinterface of the tracker is:
c9e73264 18http(s)://roundup.ffmpeg/roundup/ffmpeg/
208506e2 19Note the URLs in this document are obfuscated, you must append the top level
c9e73264
DB
20domain for non-profit organizations to the tracker, and of Italy to the
21mailing list.
119614c0
MN
22
23Email Interface:
24----------------
208506e2
DB
25There is a mailing list to which all new issues and changes to existing issues
26are sent. You can subscribe through
119614c0
MN
27http://live.polito/mailman/listinfo/ffmpeg-issues
28Replies to messages there will have their text added to the specific issues.
29Attachments will be added as if they had been uploaded via the web interface.
30You can change the status, substatus, topic, ... by changing the subject in
31your reply like:
32Re: [issue94] register_avcodec and allcodecs.h [type=patch;status=open;substatus=approved]
208506e2
DB
33Roundup will then change things as you requested and remove the [...] from
34the subject before forwarding the mail to the mailing list.
119614c0 35
0c84e744 36
208506e2 37NOTE: issue = (bug report || patch || feature request)
0c84e744
MN
38
39Type:
40-----
41bug
208506e2 42 An error, flaw, mistake, failure, or fault in FFmpeg or libav* that
0c84e744
MN
43 prevents it from behaving as intended.
44
45feature request
46 Request of support for encoding or decoding of a new codec, container
47 or variant.
d6d0182e 48 Request of support for more, less or plain different output or behavior
208506e2 49 where the current implementation cannot be considered wrong.
0c84e744
MN
50
51patch
52 A patch as generated by diff which conforms to the patch submission and
208506e2 53 development policy.
0c84e744
MN
54
55
56Priority:
57---------
58critical
d6d0182e
RD
59 Bugs and patches which deal with data loss and security issues.
60 No feature request can be critical.
0c84e744
MN
61
62important
208506e2 63 Bugs which make FFmpeg unusable for a significant number of users, and
0c84e744 64 patches fixing them.
208506e2 65 Examples here might be completely broken MPEG-4 decoding or a build issue
d6d0182e 66 on Linux.
208506e2
DB
67 While broken 4xm decoding or a broken OS/2 build would not be important,
68 the separation to normal is somewhat fuzzy.
0c84e744
MN
69 For feature requests this priority would be used for things many people
70 want.
71
72normal
73
74
75minor
76 Bugs and patches about things like spelling errors, "mp2" instead of
d6d0182e
RD
77 "mp3" being shown and such.
78 Feature requests about things few people want or which do not make a big
0c84e744
MN
79 difference.
80
81wish
57492dfe 82 Something that is desirable to have but that there is no urgency at
208506e2
DB
83 all to implement, e.g. something completely cosmetic like a website
84 restyle or a personalized doxy template or the FFmpeg logo.
85 This priority is not valid for bugs.
0c84e744
MN
86
87
88Status:
89-------
90new
91 initial state
92
93open
94 intermediate states
95
96closed
208506e2 97 final state
0c84e744
MN
98
99
100Type/Status/Substatus:
101----------
102*/new/new
103 Initial state of new bugs, patches and feature requests submitted by
208506e2 104 users.
0c84e744
MN
105
106*/open/open
d6d0182e
RD
107 Issues which have been briefly looked at and which did not look outright
108 invalid.
208506e2
DB
109 This implicates that no real more detailed state applies yet. Conversely,
110 the more detailed states below implicate that the issue has been briefly
0c84e744
MN
111 looked at.
112
113*/closed/duplicate
208506e2
DB
114 Bugs, patches or feature requests which are duplicates.
115 Note that patches dealing with the same thing in a different way are not
116 duplicates.
3f4c2431
DB
117 Note, if you mark something as duplicate, do not forget setting the
118 superseder so bug reports are properly linked.
0c84e744
MN
119
120*/closed/invalid
208506e2 121 Bugs caused by user errors, random ineligible or otherwise nonsense stuff.
0c84e744 122
82ed1ca7
MN
123*/closed/needs_more_info
124 Issues for which some information has been requested by the developers,
125 but which has not been provided by anyone within reasonable time.
126
0c84e744 127bug/open/reproduced
208506e2 128 Bugs which have been reproduced.
0c84e744
MN
129
130bug/open/analyzed
131 Bugs which have been analyzed and where it is understood what causes them
d6d0182e 132 and which exact chain of events triggers them. This analysis should be
208506e2 133 available as a message in the bug report.
0c84e744
MN
134 Note, do not change the status to analyzed without also providing a clear
135 and understandable analysis.
136 This state implicates that the bug either has been reproduced or that
208506e2 137 reproduction is not needed as the bug is already understood.
0c84e744
MN
138
139bug/open/needs_more_info
208506e2
DB
140 Bug reports which are incomplete and or where more information is needed
141 from the submitter or another person who can provide it.
d6d0182e 142 This state implicates that the bug has not been analyzed or reproduced.
a677e0cf
MN
143 Note, the idea behind needs_more_info is to offload work from the
144 developers to the users whenever possible.
0c84e744
MN
145
146bug/closed/fixed
147 Bugs which have to the best of our knowledge been fixed.
148
149bug/closed/wont_fix
fecf966f
MM
150 Bugs which we will not fix. Possible reasons include legality, high
151 complexity for the sake of supporting obscure corner cases, speed loss
152 for similarly esoteric purposes, et cetera.
88a7a2dc 153 This also means that we would reject a patch.
bf99f4fc 154 If we are just too lazy to fix a bug then the correct state is open
95049fec
MN
155 and unassigned. Closed means that the case is closed which is not
156 the case if we are just waiting for a patch.
0c84e744
MN
157
158bug/closed/works_for_me
159 Bugs for which sufficient information was provided to reproduce but
d6d0182e 160 reproduction failed - that is the code seems to work correctly to the
57492dfe 161 best of our knowledge.
0c84e744
MN
162
163patch/open/approved
164 Patches which have been reviewed and approved by a developer.
165 Such patches can be applied anytime by any other developer after some
166 reasonable testing (compile + regression tests + does the patch do
d6d0182e 167 what the author claimed).
0c84e744
MN
168
169patch/open/needs_changes
d6d0182e 170 Patches which have been reviewed and need changes to be accepted.
0c84e744
MN
171
172patch/closed/applied
d6d0182e 173 Patches which have been applied.
0c84e744
MN
174
175patch/closed/rejected
d6d0182e 176 Patches which have been rejected.
0c84e744
MN
177
178feature_request/open/needs_more_info
208506e2 179 Feature requests where it is not clear what exactly is wanted
d6d0182e 180 (these also could be closed as invalid ...).
0c84e744
MN
181
182feature_request/closed/implemented
183 Feature requests which have been implemented.
184
185feature_request/closed/wont_implement
57492dfe 186 Feature requests which will not be implemented. The reasons here could
0c84e744
MN
187 be legal, philosophical or others.
188
189Note, please do not use type-status-substatus combinations other than the
190above without asking on ffmpeg-dev first!
76757105 191
208506e2
DB
192Note2, if you provide the requested info do not forget to remove the
193needs_more_info substate.
6b90f8e0 194
76757105
LB
195Topic:
196------
197A topic is a tag you should add to your issue in order to make grouping them
c0d2d806
MN
198easier.
199
200avcodec
201 issues in libavcodec/*
202
203avformat
204 issues in libavformat/*
205
206avutil
207 issues in libavutil/*
208
209regression test
210 issues in tests/*
211
212ffmpeg
213 issues in or related to ffmpeg.c
214
215ffplay
216 issues in or related to ffplay.c
217
218ffserver
219 issues in or related to ffserver.c
220
221build system
222 issues in or related to configure/Makefile
223
224regression
208506e2 225 bugs which were working in a past revision
c0d2d806
MN
226
227roundup
228 issues related to our issue tracker