[MPlayer-dev-eng] [PATCH] RFC frameno options with cdsize with DOCs

[Diego Biurrun]

Jan Gutter writes:
> Here's the frameno options patch with documentation added.

thanks

> Any comments on how to improve the patch (for example, completely
> dropping it and going into exile) would be appreciated!

Here's some of my usual nitpicking ;)

> +pseudo\-codec used in three\-pass encoding to calculate the bitrate

The \- is not needed in these two cases, as it's just a hyphen.  You
do need it for the option name, though.  Also please start the
sentence with a capital letter and end with period.

> +The frameno pseudo-codec is used to calculate the required bitrate for a 
> +two\-pass encoding session more precisely. In order to to this, only the audio
> +is compressed. After the size of the compressed audio is subtracted from the
> +target size, a much more accurate guess can be made for the target bitrate.
> +.br
> +.I NOTE:
> +Three\-pass encoding is documented much more thoroughly in the mencoder
> +documentation. You are encouraged to consult it.

You should start new sentences on a new line in the man page.  The
same thing about the hyphen applies.

> +  <option>-framenoopts cdsize=<replaceable>size in MB</replaceable></option>
> +  option to specify the destination size for the bitrate calculation, in Mb.

Write MB in both cases, not MB and Mb.

Diego