[FFmpeg-devel] [PATCH] doc: add libavcodec.texi first version

Stefano Sabatini stefasab at gmail.com
Thu Nov 1 16:40:58 CET 2012


On date Thursday 2012-11-01 16:03:49 +0100, Michael Niedermayer encoded:
> On Thu, Nov 01, 2012 at 01:24:35PM +0100, Stefano Sabatini wrote:
> > The option chapter is based on the avoptions_codec.texi file.
> 
> avoptions_codec.texi is a generated file

Inline help has the problem that it lacks information, since it
usually consist, when available, of a more or less cryptic single line
of text. A possibility would be to add a long_help option, but I
suggest to follow this path for the moment while a better solution is
developed, having a place where to document the options is already a
big improvement.

The manual labour of keeping in synch avcodec.h/options help/manual is
IMHO a minor issue, given that right now the main problem is that
nobody ever tried to document the various options in the first place.

Patch updated with some manual editing.
-- 
FFmpeg = Foolish and Fanciful Maxi Pure Elegant Goblin
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-doc-add-libavcodec.texi.patch
Type: text/x-diff
Size: 28787 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20121101/e893ec52/attachment.bin>


More information about the ffmpeg-devel mailing list