[FFmpeg-devel] [PATCH] Documentation cleanup - image formats

[Diego Biurrun]

Sorry, this took a bit longer than usual..

On Thu, Feb 19, 2009 at 08:08:51PM -0600, Daniel Verkamp wrote:
> 
> Attached are several trivial patches to (somewhat) clean up and update
> the Image Formats section of the documentation.

All patches except for the second are applied, many thanks.

> I will happily clean up more of the formats documentation as well, but
> I'm not sure how useful it is currently; it's pretty much a mess both
> for users and developers, from what I've seen.  The comments field is
> especially confusing, as it's a sort of free-for-all, sometimes
> containing FourCCs, other times shortcomings of the current
> implementation, occasionally whether an external library is needed,
> and yet others general descriptions of the format/codec.  It also is
> inconsistent in whether it ends in a period or not, what voice it is
> written in, etc.  With some guidance as to what is actually desired,
> I'll gladly try to wrangle all this into something useful...

Hmmmmm..

Yes, it should be made consistent, patches doing that are welcome.
Personally, I think the fourccs are useless in this place.  I haven't
yet put much thought to the rest.

> Maybe some kind of autogenerated list like ffmpeg -formats would be
> better than manually updating the docs all the time?  (I started on
> this, but couldn't find any way to tell image codecs from other video
> codecs automatically, and at least this distinction makes the
> documentation more useful than the raw -formats output, so I didn't
> want to drop it.)

I have had the same thought, but AFAIK there is currently no way to
differentiate them.

Diego