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

Stefano Sabatini stefasab at gmail.com
Sat Nov 3 00:09:02 CET 2012

On date Friday 2012-11-02 16:44:53 +0100, Michael Niedermayer encoded:
> 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.

I can fix them in the table and then apply this one, since I don't
plan to keep a literal correspondence between the two and I already
did the editing work once and I won't do it a second time. The reason
for which I didn't edit the option help was to by-pass bikeshedding
and avoid (even more) merge conflicts.

Regarding the capitalization and punctuation, rigth now that table
contains all the possible variants:

set the bikeshed color
set the bikeshed color.
Set the bikeshed color
Set the bikeshed color.
bikeshed color
Bikeshed color
Sets the bikeshed color
Sets the bikeshed color.

My tendency (implemented already in most filters) is to prefer the
first variant:
set the bikeshed color

so I'd rather go with that (which is possibly different from the form
adopted in the documentation), but I don't want to do it and having to
redo it again because of objections.
FFmpeg = Formidable and Fiendish Multimedia Pitiless Erroneous Gargoyle

More information about the ffmpeg-devel mailing list