opensource/FFmpeg
1
0
Fork 0
mirror of https://github.com/FFmpeg/FFmpeg.git synced 2025-05-17 23:17:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

Documentation updates for the git migration

Browse Source 
This cleanup patch updates the developer documentation with respect to
the migration to the git scm.
This commit is contained in:
Reinhard Tartler
2011-02-07 17:17:30 +01:00
parent ae2104791f
commit 87800dc2bf
4 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/TODO
View File

@ -69,7 +69,7 @@ unassigned TODO: (unordered)
- JPEG2000 decoder & encoder - JPEG2000 decoder & encoder
- MPEG4 GMC encoding support - MPEG4 GMC encoding support
- macroblock based pixel format (better cache locality, somewhat complex, one paper claimed it faster for high res) - macroblock based pixel format (better cache locality, somewhat complex, one paper claimed it faster for high res)
- regression tests for codecs which do not have an encoder (I+P-frame bitstream in svn) - regression tests for codecs which do not have an encoder (I+P-frame bitstream in the 'master' branch)
- add support for using mplayers video filters to ffmpeg - add support for using mplayers video filters to ffmpeg
- H264 encoder - H264 encoder
- per MB ratecontrol (so VCD and such do work better) - per MB ratecontrol (so VCD and such do work better)

6
doc/developer.texi
View File

@ -312,7 +312,7 @@ send a reminder by email. Your patch should eventually be dealt with.
If it depends on a parser or a library, did you add that dependency in If it depends on a parser or a library, did you add that dependency in
configure? configure?
@item @item
Did you "svn add" the appropriate files before commiting? Did you "git add" the appropriate files before committing?
@end enumerate @end enumerate
@section patch submission checklist @section patch submission checklist
@ -325,7 +325,7 @@ send a reminder by email. Your patch should eventually be dealt with.
@item @item
Is the patch a unified diff? Is the patch a unified diff?
@item @item
Is the patch against latest FFmpeg SVN? Is the patch against latest FFmpeg git master branch?
@item @item
Are you subscribed to ffmpeg-dev? Are you subscribed to ffmpeg-dev?
(the list is subscribers only due to spam) (the list is subscribers only due to spam)
@ -388,7 +388,7 @@ send a reminder by email. Your patch should eventually be dealt with.
@section Patch review process @section Patch review process
All patches posted to ffmpeg-devel will be reviewed, unless they contain a All patches posted to ffmpeg-devel will be reviewed, unless they contain a
clear note that the patch is not for SVN. clear note that the patch is not for the git master branch.
Reviews and comments will be posted as replies to the patch on the Reviews and comments will be posted as replies to the patch on the
mailing list. The patch submitter then has to take care of every comment, mailing list. The patch submitter then has to take care of every comment,
that can be by resubmitting a changed patch or by discussion. Resubmitted that can be by resubmitting a changed patch or by discussion. Resubmitted

4
doc/optimization.txt
View File

@ -17,8 +17,8 @@ Understanding these overoptimized functions:
As many functions tend to be a bit difficult to understand because As many functions tend to be a bit difficult to understand because
of optimizations, it can be hard to optimize them further, or write of optimizations, it can be hard to optimize them further, or write
architecture-specific versions. It is recommended to look at older architecture-specific versions. It is recommended to look at older
revisions of the interesting files (for a web frontend try ViewVC at revisions of the interesting files (web frontends for the various FFmpeg
http://svn.ffmpeg.org/ffmpeg/trunk/). branches are listed at http://ffmpeg.org/download.html).
Alternatively, look into the other architecture-specific versions in Alternatively, look into the other architecture-specific versions in
the x86/, ppc/, alpha/ subdirectories. Even if you don't exactly the x86/, ppc/, alpha/ subdirectories. Even if you don't exactly
comprehend the instructions, it could help understanding the functions comprehend the instructions, it could help understanding the functions

4
doc/soc.txt
View File

@ -9,14 +9,14 @@ it's a little late for this year's soc (2006).
The Goal: The Goal:
Our goal in respect to soc is and must be of course exactly one thing and Our goal in respect to soc is and must be of course exactly one thing and
that is to improve FFmpeg, to reach this goal, code must that is to improve FFmpeg, to reach this goal, code must
* conform to the svn policy and patch submission guidelines * conform to the development policy and patch submission guidelines
* must improve FFmpeg somehow (faster, smaller, "better", * must improve FFmpeg somehow (faster, smaller, "better",
more codecs supported, fewer bugs, cleaner, ...) more codecs supported, fewer bugs, cleaner, ...)
for mentors and other developers to help students to reach that goal it is for mentors and other developers to help students to reach that goal it is
essential that changes to their codebase are publicly visible, clean and essential that changes to their codebase are publicly visible, clean and
easy reviewable that again leads us to: easy reviewable that again leads us to:
* use of a revision control system like svn * use of a revision control system like git
* separation of cosmetic from non-cosmetic changes (this is almost entirely * separation of cosmetic from non-cosmetic changes (this is almost entirely
ignored by mentors and students in soc 2006 which might lead to a suprise ignored by mentors and students in soc 2006 which might lead to a suprise
when the code will be reviewed at the end before a possible inclusion in when the code will be reviewed at the end before a possible inclusion in