[FFmpeg-devel] [PATCH] doc/encoders: add libvorbis doc

Stefano Sabatini stefasab at gmail.com
Thu Oct 24 11:20:14 CEST 2013


On date Wednesday 2013-10-23 20:39:38 -0700, Timothy Gu encoded:
> On Sun, Oct 20, 2013 at 10:38 AM, Stefano Sabatini <stefasab at gmail.com> wrote:
> > On date Friday 2013-10-18 17:07:27 -0700, Timothy Gu encoded:
> >> Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
> >> ---
> >>  doc/encoders.texi | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
> >>  1 file changed, 50 insertions(+)
> >>
> >> diff --git a/doc/encoders.texi b/doc/encoders.texi
> >> index a96c1fc..ed61516 100644
> >> --- a/doc/encoders.texi
> >> +++ b/doc/encoders.texi
> >> @@ -771,6 +771,56 @@ respectively. The default is 0 (cutoff disabled).
> >>
> >>  @end table
> >>
> >> + at section libvorbis
> >> +
> >> +libvorbis encoder wrapper.
> >> +
> >> +Requires the presence of the libvorbisenc headers and library during
> >> +configuration. You need to explicitly configure the build with
> >> + at code{--enable-libvorbis}.
> >> +
> >> + at subsection Options
> >> +
> >
> >> +The following is an option mapping table describing options supported
> >> +by the libvorbis wrapper, and their @command{oggenc}-equivalent
> >> +in parentheses.
> >
> > I prefer this (simpler and more direct):
> >
> > The following options are supported by the libvorbis wrapper. The
> > @command{oggenc}-equivalent of the options are listed in parentheses.
> >
> > (you can skip the first sentence)
> >
> >> +
> >> +To get a more accurate and extensive documentation of the libvorbis
> >> +options, consult the libvorbisenc's and @command{oggenc}'s documentations.
> >
> > Possibly provide a link to the project website,
> 
> Done
> 
> > and while at it also a link to oggenc(1) manual.
> 
> oggenc(1) doesn't have an official online manual. I just set one up
> here http://timothygu.github.io/vorbis-tools/oggenc.html, but I'm not
> sure if we can use it.

oggenc(1) is enough (changed in the patch).

[...]
> All other notes and nits fixed.
> 
> Timothy

> From f8da44d33108b476e713d20c08b285cd0777f75d Mon Sep 17 00:00:00 2001
> From: Timothy Gu <timothygu99 at gmail.com>
> Date: Wed, 16 Oct 2013 20:33:48 -0700
> Subject: [PATCH] doc/encoders: add libvorbis doc
> 
> Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
> ---
>  doc/encoders.texi | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 51 insertions(+)

Will push it soon, thanks.
-- 
FFmpeg = Fabulous and Fabulous Muttering Perfectionist Enlightened Game


More information about the ffmpeg-devel mailing list