mirror of
https://github.com/FFmpeg/FFmpeg.git
synced 2024-12-23 12:43:46 +02:00
spelling/wording/grammar
Originally committed as revision 10489 to svn://svn.ffmpeg.org/ffmpeg/trunk
This commit is contained in:
parent
2956957151
commit
208506e2a6
@ -1,55 +1,55 @@
|
||||
ffmpegs bug/patch/feature request tracker manual
|
||||
================================================
|
||||
FFmpeg's bug/patch/feature request tracker manual
|
||||
=================================================
|
||||
|
||||
NOTE, this is a draft
|
||||
NOTE: This is a draft.
|
||||
|
||||
Overview:
|
||||
---------
|
||||
FFmpeg uses roundup for tracking issues, new issues and changes to
|
||||
FFmpeg uses Roundup for tracking issues, new issues and changes to
|
||||
existing issues can be done through a web interface and through email.
|
||||
It is possible to subscribe to individual issues by adding yourself to the
|
||||
nosy list or to subscribe to the ffmpeg-issues mailing list which receives
|
||||
a mail for every change to every issue. Replies to such mails will also
|
||||
properly be added to the respective issue.
|
||||
be properly added to the respective issue.
|
||||
(the above does all work already after light testing)
|
||||
The subscription URL for the ffmpeg-issues list is:
|
||||
http://live.polito/mailman/listinfo/ffmpeg-issues
|
||||
The URL of the webinterface of the tracker is:
|
||||
http(s)://roundup.mplayerhq/roundup/ffmpeg/
|
||||
Note the URLs in this document are obfuscated, you must append top level
|
||||
domain of hungary to the tracker, and italy to the mailinglist.
|
||||
Note the URLs in this document are obfuscated, you must append the top level
|
||||
domain of Hungary to the tracker, and of Italy to the mailing list.
|
||||
|
||||
Email Interface:
|
||||
----------------
|
||||
Theres a mailinglist to which all new issues and changes to existing issues
|
||||
are sent to, you can subscribe through
|
||||
There is a mailing list to which all new issues and changes to existing issues
|
||||
are sent. You can subscribe through
|
||||
http://live.polito/mailman/listinfo/ffmpeg-issues
|
||||
Replies to messages there will have their text added to the specific issues.
|
||||
Attachments will be added as if they had been uploaded via the web interface.
|
||||
You can change the status, substatus, topic, ... by changing the subject in
|
||||
your reply like:
|
||||
Re: [issue94] register_avcodec and allcodecs.h [type=patch;status=open;substatus=approved]
|
||||
roundup will then change things as you requested and remove the [...] from
|
||||
the subject before forwarding the mail to the mailinglist
|
||||
Roundup will then change things as you requested and remove the [...] from
|
||||
the subject before forwarding the mail to the mailing list.
|
||||
|
||||
|
||||
note: issue = (bug report || patch || feature request)
|
||||
NOTE: issue = (bug report || patch || feature request)
|
||||
|
||||
Type:
|
||||
-----
|
||||
bug
|
||||
An error, flaw, mistake, failure, or fault in ffmpeg or libav* that
|
||||
An error, flaw, mistake, failure, or fault in FFmpeg or libav* that
|
||||
prevents it from behaving as intended.
|
||||
|
||||
feature request
|
||||
Request of support for encoding or decoding of a new codec, container
|
||||
or variant.
|
||||
Request of support for more, less or plain different output or behavior
|
||||
where the current behavior cannot be considered wrong.
|
||||
where the current implementation cannot be considered wrong.
|
||||
|
||||
patch
|
||||
A patch as generated by diff which conforms to the patch submission and
|
||||
Development Policy.
|
||||
development policy.
|
||||
|
||||
|
||||
Priority:
|
||||
@ -59,12 +59,12 @@ critical
|
||||
No feature request can be critical.
|
||||
|
||||
important
|
||||
Bugs which make ffmpeg unusable for a significant number of users, and
|
||||
Bugs which make FFmpeg unusable for a significant number of users, and
|
||||
patches fixing them.
|
||||
Examples here might be completely broken mpeg4 decoding or a build issue
|
||||
Examples here might be completely broken MPEG-4 decoding or a build issue
|
||||
on Linux.
|
||||
While broken 4xm decoding or broken OS/2 build would not be important, the
|
||||
separation to normal is somewhat fuzzy ...
|
||||
While broken 4xm decoding or a broken OS/2 build would not be important,
|
||||
the separation to normal is somewhat fuzzy.
|
||||
For feature requests this priority would be used for things many people
|
||||
want.
|
||||
|
||||
@ -79,9 +79,9 @@ minor
|
||||
|
||||
wish
|
||||
Something that is desirable to have but that there is no urgency at
|
||||
all to implement, e.g.: something completely cosmetic like a
|
||||
website restyle or a personalized doxy template or the ffmpeg logo.
|
||||
This priority isn't valid for bugs.
|
||||
all to implement, e.g. something completely cosmetic like a website
|
||||
restyle or a personalized doxy template or the FFmpeg logo.
|
||||
This priority is not valid for bugs.
|
||||
|
||||
|
||||
Status:
|
||||
@ -93,44 +93,45 @@ open
|
||||
intermediate states
|
||||
|
||||
closed
|
||||
Final state
|
||||
final state
|
||||
|
||||
|
||||
Type/Status/Substatus:
|
||||
----------
|
||||
*/new/new
|
||||
Initial state of new bugs, patches and feature requests submitted by
|
||||
users
|
||||
users.
|
||||
|
||||
*/open/open
|
||||
Issues which have been briefly looked at and which did not look outright
|
||||
invalid.
|
||||
This implicates that no real more detailed state applies yet. And the
|
||||
more detailed states below implicate that the issue has been briefly
|
||||
This implicates that no real more detailed state applies yet. Conversely,
|
||||
the more detailed states below implicate that the issue has been briefly
|
||||
looked at.
|
||||
|
||||
*/closed/duplicate
|
||||
Bugs, patches or feature requests which are duplicate of some other.
|
||||
Note patches dealing with the same thing but differently are not duplicate.
|
||||
Bugs, patches or feature requests which are duplicates.
|
||||
Note that patches dealing with the same thing in a different way are not
|
||||
duplicates.
|
||||
|
||||
*/closed/invalid
|
||||
Bugs caused by user errors, random ineligible or otherwise nonsense stuff
|
||||
Bugs caused by user errors, random ineligible or otherwise nonsense stuff.
|
||||
|
||||
bug/open/reproduced
|
||||
Bugs which have been reproduced
|
||||
Bugs which have been reproduced.
|
||||
|
||||
bug/open/analyzed
|
||||
Bugs which have been analyzed and where it is understood what causes them
|
||||
and which exact chain of events triggers them. This analysis should be
|
||||
available as a message in the bugreport.
|
||||
available as a message in the bug report.
|
||||
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
|
||||
reproduction is not needed as the bug is understood already anyway.
|
||||
reproduction is not needed as the bug is already understood.
|
||||
|
||||
bug/open/needs_more_info
|
||||
Bugreports which are incomplete and or where more information is needed
|
||||
from the submitter or another person who can provide the info.
|
||||
Bug reports which are incomplete and or where more information is needed
|
||||
from the submitter or another person who can provide it.
|
||||
This state implicates that the bug has not been analyzed or reproduced.
|
||||
Note, the idea behind needs_more_info is to offload work from the
|
||||
developers to the users whenever possible.
|
||||
@ -163,7 +164,7 @@ patch/closed/rejected
|
||||
Patches which have been rejected.
|
||||
|
||||
feature_request/open/needs_more_info
|
||||
Feature requests where its not clear what exactly is wanted
|
||||
Feature requests where it is not clear what exactly is wanted
|
||||
(these also could be closed as invalid ...).
|
||||
|
||||
feature_request/closed/implemented
|
||||
@ -176,8 +177,8 @@ feature_request/closed/wont_implement
|
||||
Note, please do not use type-status-substatus combinations other than the
|
||||
above without asking on ffmpeg-dev first!
|
||||
|
||||
Note2, if you provide the requested info dont forget to remove the
|
||||
needs_more_info substate
|
||||
Note2, if you provide the requested info do not forget to remove the
|
||||
needs_more_info substate.
|
||||
|
||||
Topic:
|
||||
------
|
||||
@ -209,7 +210,7 @@ build system
|
||||
issues in or related to configure/Makefile
|
||||
|
||||
regression
|
||||
bugs which where working in a past revission
|
||||
bugs which were working in a past revision
|
||||
|
||||
roundup
|
||||
issues related to our issue tracker
|
||||
|
Loading…
Reference in New Issue
Block a user