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

Michael Niedermayer michaelni at gmx.at
Fri Nov 2 16:44:53 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.
> Patch updated with some manual editing.

diffing against the automatically generated docs:
>  @item pass1
> -use internal 2pass ratecontrol in first  pass mode
> +Use internal 2pass ratecontrol in first pass mode.
>  @item pass2
> -use internal 2pass ratecontrol in second pass mode
> +Use internal 2pass ratecontrol in second pass mode.
>  @item gray
> -only decode/encode grayscale
> +Only decode/encode grayscale.
>  @item emu_edge
> -don't draw edges
> +Do not draw edges.
>  @item psnr
> -error[?] variables will be set during encoding
> +Set error[?] variables during encoding.
>  @item truncated

Fixing typos should happen in teh source not in a manually
duplicated text of it while leaving the source typos in place

Formating mistakes in the texi generator like capitalization and
adding a . should be fixed in the texi generator.

Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Rewriting code that is poorly written but fully understood is good.
Rewriting code that one doesnt understand is a sign that one is less smart
then the original author, trying to rewrite it will not make it better.
-------------- 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/20121102/11565f81/attachment.asc>

More information about the ffmpeg-devel mailing list