[FFmpeg-devel] [PATCH 1/3] doc/encoders: reformat libwavpack documentation

[Stefano Sabatini]

On date Saturday 2013-11-30 15:39:55 -0800, Timothy Gu encoded:
> Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
> ---
>  doc/encoders.texi | 37 +++++++++++++++++++++++++------------
>  1 file changed, 25 insertions(+), 12 deletions(-)
> 
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index a93edb4..cebce25 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -1149,28 +1149,41 @@ transient response is a higher bitrate.
>  A wrapper providing WavPack encoding through libwavpack.
>  
>  Only lossless mode using 32-bit integer samples is supported currently.
> -The @option{compression_level} option can be used to control speed vs.
> -compression tradeoff, with the values mapped to libwavpack as follows:
> +

> +Note that a libavcodec-native encoder for the WavPack codec exists so users can
> +encode audios with this codec without using this encoder.
> +
> +Requires the presence of the libwavpack headers and library during
> +configuration. You need to explicitly configure the build with
> + at code{--enable-libwavpack}.

Maybe switch these two sentences.

> +
> + at subsection Options
>  
>  @table @option
> + at item compression_level
> +Set speed vs. compression tradeoff. Acceptable arguments, with @command{wavpack}
> +command line utility's corresponding options are listed in parentheses, are
> +listed below:
>  
> - at item 0
> -Fast mode - corresponding to the wavpack @option{-f} option.
> + at table @samp
> + at item 0 (@emph{-f})
> +Fast mode.
>  
>  @item 1
>  Normal (default) settings.
>  
> - at item 2
> -High quality - corresponding to the wavpack @option{-h} option.
> + at item 2 (@emph{-h})
> +High quality.
>  
> - at item 3
> -Very high quality - corresponding to the wavpack @option{-hh} option.
> + at item 3 (@emph{-hh})
> +Very high quality.
>  
> - at item 4-8
> -Same as 3, but with extra processing enabled - corresponding to the wavpack
> - at option{-x} option. I.e. 4 is the same as @option{-x2} and 8 is the same as
> - at option{-x6}.
> + at item 4-8 (@emph{-hh -x}@var{EXTRAPROC})
> +Same as @samp{3}, but with extra processing enabled.
>  
> + at samp{4} is the same as @option{-x2} and @samp{8} is the same as @option{-x6}.
> +
> + at end table

LGTM otherwise.
-- 
FFmpeg = Fantastic Frenzy Mournful Prodigious Eccentric Game