Statistics
| Branch: | Revision:

ffmpeg / doc / issue_tracker.txt @ 71253ce9

History | View | Annotate | Download (6.68 KB)

1
ffmpegs 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
properly be 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 top level
20
domain of hungary to the tracker, and italy to the mailinglist.
21

    
22
Email Interface:
23
----------------
24
Theres a mailinglist to which all new issues and changes to existing issues
25
are sent to, 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 mailinglist
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 behavior 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 mpeg4 decoding or a build issue
65
    on Linux.
66
    While broken 4xm decoding or broken OS/2 build would not be important, the
67
    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
83
    website restyle or a personalized doxy template or the ffmpeg logo.
84
    This priority isn't 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. And the
109
    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 duplicate of some other.
114
    Note patches dealing with the same thing but differently are not duplicate.
115

    
116
*/closed/invalid
117
    Bugs caused by user errors, random ineligible or otherwise nonsense stuff
118

    
119
bug/open/reproduced
120
    Bugs which have been reproduced
121

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

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

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

    
141
bug/closed/wont_fix
142
    Bugs which we will not fix, the reasons here could be legal, philosophical
143
    or others.
144

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

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

    
156
patch/open/needs_changes
157
    Patches which have been reviewed and need changes to be accepted.
158

    
159
patch/closed/applied
160
    Patches which have been applied.
161

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

    
165
feature_request/open/needs_more_info
166
    Feature requests where its not clear what exactly is wanted
167
    (these also could be closed as invalid ...).
168

    
169
feature_request/closed/implemented
170
    Feature requests which have been implemented.
171

    
172
feature_request/closed/wont_implement
173
    Feature requests which will not be implemented. The reasons here could
174
    be legal, philosophical or others.
175

    
176
Note, please do not use type-status-substatus combinations other than the
177
above without asking on ffmpeg-dev first!
178

    
179
Note2, if you provide the requested info dont forget to remove the
180
needs_more_info substate
181

    
182
Topic:
183
------
184
A topic is a tag you should add to your issue in order to make grouping them
185
easier.
186

    
187
avcodec
188
    issues in libavcodec/*
189

    
190
avformat
191
    issues in libavformat/*
192

    
193
avutil
194
    issues in libavutil/*
195

    
196
regression test
197
    issues in tests/*
198

    
199
ffmpeg
200
    issues in or related to ffmpeg.c
201

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

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

    
208
build system
209
    issues in or related to configure/Makefile
210

    
211
regression
212
    bugs which where working in a past revission
213

    
214
roundup
215
    issues related to our issue tracker