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

Michael Niedermayer michaelni at gmx.at
Thu Nov 1 22:06:25 CET 2012


On Thu, Nov 01, 2012 at 04:40:58PM +0100, Stefano Sabatini wrote:
> 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.

please add yourself in MAINTAINERS for this file then

also can you write a script that cross checks the 2 lists against
missing options?
if you want to maintain the texi by hand this should make your work
easier

[...]
-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Many that live deserve death. And some that die deserve life. Can you give
it to them? Then do not be too eager to deal out death in judgement. For
even the very wise cannot see all ends. -- Gandalf
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: Digital signature
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20121101/55681d93/attachment.asc>


More information about the ffmpeg-devel mailing list