make it a little harder to find the tracker, this should hopefully
[ffmpeg.git] / doc / issue_tracker.txt
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 use the URLs above you must append top level domain of
20 hungary to the tracker, and italy to the mailinglist
21
22 note: issue = (bug report || patch || feature request)
23
24 Type:
25 -----
26 bug
27     An error, flaw, mistake, failure, or fault in ffmpeg or libav* that
28     prevents it from behaving as intended.
29
30 feature request
31     Request of support for encoding or decoding of a new codec, container
32     or variant.
33     Request of support for more, less or plain different output or behavior
34     where the current behavior cannot be considered wrong.
35
36 patch
37     A patch as generated by diff which conforms to the patch submission and
38     Development Policy.
39
40
41 Priority:
42 ---------
43 critical
44     Bugs and patches which deal with data loss and security issues.
45     No feature request can be critical.
46
47 important
48     Bugs which make ffmpeg unusable for a significant number of users, and
49     patches fixing them.
50     Examples here might be completely broken mpeg4 decoding or a build issue
51     on Linux.
52     While broken 4xm decoding or broken OS/2 build would not be important, the
53     separation to normal is somewhat fuzzy ...
54     For feature requests this priority would be used for things many people
55     want.
56
57 normal
58
59
60 minor
61     Bugs and patches about things like spelling errors, "mp2" instead of
62     "mp3" being shown and such.
63     Feature requests about things few people want or which do not make a big
64     difference.
65
66 wish
67     Something that is desirable to have but that there is no urgency at
68     all to implement, e.g.: something completely cosmetic like a
69     website restyle or a personalized doxy template or the ffmpeg logo.
70     This priority isn't valid for bugs.
71
72
73 Status:
74 -------
75 new
76     initial state
77
78 open
79     intermediate states
80
81 closed
82     Final state
83
84
85 Type/Status/Substatus:
86 ----------
87 */new/new
88     Initial state of new bugs, patches and feature requests submitted by
89     users
90
91 */open/open
92     Issues which have been briefly looked at and which did not look outright
93     invalid.
94     This implicates that no real more detailed state applies yet. And the
95     more detailed states below implicate that the issue has been briefly
96     looked at.
97
98 */closed/duplicate
99     Bugs, patches or feature requests which are duplicate of some other.
100     Note patches dealing with the same thing but differently are not duplicate.
101
102 */closed/invalid
103     Bugs caused by user errors, random ineligible or otherwise nonsense stuff
104
105 bug/open/reproduced
106     Bugs which have been reproduced
107
108 bug/open/analyzed
109     Bugs which have been analyzed and where it is understood what causes them
110     and which exact chain of events triggers them. This analysis should be
111     available as a message in the bugreport.
112     Note, do not change the status to analyzed without also providing a clear
113     and understandable analysis.
114     This state implicates that the bug either has been reproduced or that
115     reproduction is not needed as the bug is understood already anyway.
116
117 bug/open/needs_more_info
118     Bugreports which are incomplete and or where more information is needed
119     from the submitter or another person who can provide the info.
120     This state implicates that the bug has not been analyzed or reproduced.
121
122 bug/closed/fixed
123     Bugs which have to the best of our knowledge been fixed.
124
125 bug/closed/wont_fix
126     Bugs which we will not fix, the reasons here could be legal, philosophical
127     or others.
128
129 bug/closed/works_for_me
130     Bugs for which sufficient information was provided to reproduce but
131     reproduction failed - that is the code seems to work correctly to the
132     best of our knowledge.
133
134 patch/open/approved
135     Patches which have been reviewed and approved by a developer.
136     Such patches can be applied anytime by any other developer after some
137     reasonable testing (compile + regression tests + does the patch do
138     what the author claimed).
139
140 patch/open/needs_changes
141     Patches which have been reviewed and need changes to be accepted.
142
143 patch/closed/applied
144     Patches which have been applied.
145
146 patch/closed/rejected
147     Patches which have been rejected.
148
149 feature_request/open/needs_more_info
150     Feature requests where its not clear what exactly is wanted
151     (these also could be closed as invalid ...).
152
153 feature_request/closed/implemented
154     Feature requests which have been implemented.
155
156 feature_request/closed/wont_implement
157     Feature requests which will not be implemented. The reasons here could
158     be legal, philosophical or others.
159
160 Note, please do not use type-status-substatus combinations other than the
161 above without asking on ffmpeg-dev first!
162
163 Note2, if you provide the requested info dont forget to remove the
164 needs_more_info substate
165
166 Topic:
167 ------
168 A topic is a tag you should add to your issue in order to make grouping them
169 easier.
170
171 avcodec
172     issues in libavcodec/*
173
174 avformat
175     issues in libavformat/*
176
177 avutil
178     issues in libavutil/*
179
180 regression test
181     issues in tests/*
182
183 ffmpeg
184     issues in or related to ffmpeg.c
185
186 ffplay
187     issues in or related to ffplay.c
188
189 ffserver
190     issues in or related to ffserver.c
191
192 build system
193     issues in or related to configure/Makefile
194
195 regression
196     bugs which where working in a past revission
197
198 roundup
199     issues related to our issue tracker