a6be21d3 |
FFmpeg's bug/patch/feature request tracker manual
================================================= |
0c84e744 |
|
208506e2 |
NOTE: This is a draft. |
0c84e744 |
Overview:
--------- |
3df9150d |
FFmpeg uses Trac for tracking issues, new issues and changes to
existing issues can be done through a web interface. |
d6d0182e |
It is possible to subscribe to individual issues by adding yourself to the |
57492dfe |
nosy list or to subscribe to the ffmpeg-issues mailing list which receives |
0c84e744 |
a mail for every change to every issue. Replies to such mails will also |
208506e2 |
be properly added to the respective issue. |
0c84e744 |
(the above does all work already after light testing) |
3df9150d |
The subscription URL for the ffmpeg-trac list is:
http(s)://ffmpeg.org/mailman/listinfo/ffmpeg-trac |
80c24d99 |
The URL of the webinterface of the tracker is: |
3df9150d |
http(s)://ffmpeg.org/trac/ffmpeg |
0c84e744 |
|
208506e2 |
NOTE: issue = (bug report || patch || feature request) |
0c84e744 |
Type:
-----
bug |
208506e2 |
An error, flaw, mistake, failure, or fault in FFmpeg or libav* that |
0c84e744 |
prevents it from behaving as intended.
feature request
Request of support for encoding or decoding of a new codec, container
or variant. |
d6d0182e |
Request of support for more, less or plain different output or behavior |
208506e2 |
where the current implementation cannot be considered wrong. |
0c84e744 |
patch
A patch as generated by diff which conforms to the patch submission and |
208506e2 |
development policy. |
0c84e744 |
Priority:
---------
critical |
d6d0182e |
Bugs and patches which deal with data loss and security issues.
No feature request can be critical. |
0c84e744 |
important |
a6be21d3 |
Bugs which make FFmpeg unusable for a significant number of users, and |
0c84e744 |
patches fixing them. |
208506e2 |
Examples here might be completely broken MPEG-4 decoding or a build issue |
d6d0182e |
on Linux. |
208506e2 |
While broken 4xm decoding or a broken OS/2 build would not be important,
the separation to normal is somewhat fuzzy. |
0c84e744 |
For feature requests this priority would be used for things many people
want.
normal
minor
Bugs and patches about things like spelling errors, "mp2" instead of |
d6d0182e |
"mp3" being shown and such.
Feature requests about things few people want or which do not make a big |
0c84e744 |
difference.
wish |
57492dfe |
Something that is desirable to have but that there is no urgency at |
208506e2 |
all to implement, e.g. something completely cosmetic like a website |
a6be21d3 |
restyle or a personalized doxy template or the FFmpeg logo. |
208506e2 |
This priority is not valid for bugs. |
0c84e744 |
Status:
-------
new
initial state
open
intermediate states
closed |
208506e2 |
final state |
0c84e744 |
Type/Status/Substatus:
----------
*/new/new
Initial state of new bugs, patches and feature requests submitted by |
208506e2 |
users. |
0c84e744 |
*/open/open |
d6d0182e |
Issues which have been briefly looked at and which did not look outright
invalid. |
208506e2 |
This implicates that no real more detailed state applies yet. Conversely,
the more detailed states below implicate that the issue has been briefly |
0c84e744 |
looked at.
*/closed/duplicate |
208506e2 |
Bugs, patches or feature requests which are duplicates.
Note that patches dealing with the same thing in a different way are not
duplicates. |
3f4c2431 |
Note, if you mark something as duplicate, do not forget setting the
superseder so bug reports are properly linked. |
0c84e744 |
*/closed/invalid |
208506e2 |
Bugs caused by user errors, random ineligible or otherwise nonsense stuff. |
0c84e744 |
|
82ed1ca7 |
*/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.
|
0c84e744 |
bug/open/reproduced |
208506e2 |
Bugs which have been reproduced. |
0c84e744 |
bug/open/analyzed
Bugs which have been analyzed and where it is understood what causes them |
d6d0182e |
and which exact chain of events triggers them. This analysis should be |
208506e2 |
available as a message in the bug report. |
0c84e744 |
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 |
208506e2 |
reproduction is not needed as the bug is already understood. |
0c84e744 |
bug/open/needs_more_info |
208506e2 |
Bug reports which are incomplete and or where more information is needed
from the submitter or another person who can provide it. |
d6d0182e |
This state implicates that the bug has not been analyzed or reproduced. |
a677e0cf |
Note, the idea behind needs_more_info is to offload work from the
developers to the users whenever possible. |
0c84e744 |
bug/closed/fixed
Bugs which have to the best of our knowledge been fixed.
bug/closed/wont_fix |
fecf966f |
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. |
88a7a2dc |
This also means that we would reject a patch. |
bf99f4fc |
If we are just too lazy to fix a bug then the correct state is open |
95049fec |
and unassigned. Closed means that the case is closed which is not
the case if we are just waiting for a patch. |
0c84e744 |
bug/closed/works_for_me
Bugs for which sufficient information was provided to reproduce but |
d6d0182e |
reproduction failed - that is the code seems to work correctly to the |
57492dfe |
best of our knowledge. |
0c84e744 |
patch/open/approved
Patches which have been reviewed and approved by a developer.
Such patches can be applied anytime by any other developer after some
reasonable testing (compile + regression tests + does the patch do |
d6d0182e |
what the author claimed). |
0c84e744 |
patch/open/needs_changes |
d6d0182e |
Patches which have been reviewed and need changes to be accepted. |
0c84e744 |
patch/closed/applied |
d6d0182e |
Patches which have been applied. |
0c84e744 |
patch/closed/rejected |
d6d0182e |
Patches which have been rejected. |
0c84e744 |
feature_request/open/needs_more_info |
208506e2 |
Feature requests where it is not clear what exactly is wanted |
d6d0182e |
(these also could be closed as invalid ...). |
0c84e744 |
feature_request/closed/implemented
Feature requests which have been implemented.
feature_request/closed/wont_implement |
57492dfe |
Feature requests which will not be implemented. The reasons here could |
0c84e744 |
be legal, philosophical or others.
Note, please do not use type-status-substatus combinations other than the |
2d2b5a14 |
above without asking on ffmpeg-dev first! |
76757105 |
|
208506e2 |
Note2, if you provide the requested info do not forget to remove the
needs_more_info substate. |
6b90f8e0 |
|
76757105 |
Topic:
------
A topic is a tag you should add to your issue in order to make grouping them |
c0d2d806 |
easier.
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
ffserver
issues in or related to ffserver.c
build system
issues in or related to configure/Makefile
regression |
208506e2 |
bugs which were working in a past revision |
c0d2d806 |
roundup
issues related to our issue tracker |