[FFmpeg-devel] [PATCH] Add documentation for the CRC muxer.

[Diego Biurrun]

On Tue, Feb 01, 2011 at 11:41:05AM +0100, Stefano Sabatini wrote:
> 
> Updated.
> 
> --- a/doc/muxers.texi
> +++ b/doc/muxers.texi
> @@ -18,6 +18,39 @@ enabled muxers.
>  
> + at section crc
> +
> +CRC (Cyclic Redundancy Check) testing format.

I still don't like these non-sentences as starters.

> +This muxer computes and prints the Adler-32 CRC of all the input audio
> +and video frames. By default the CRC is computed on the decoded input
> +audio and video frames converted respectively to rawvideo and signed
> +16-bit rawaudio.

You are very fond of the word "respectively", but I would suggest to
avoid it.  In general I would recommend that you attempt to write with
simpler grammatical structure.  It is usually far easier to understand,
witness:

  By default audio frames are converted to signed 16-bit raw audio and
  video frames to raw video before computing the CRC.

> +The output of the muxer consists of a single line of the form:
> +CRC=0x at var{CRC}, where @var{CRC} is an hexadecimal number 0-padded to

s/an/a/

> +You can print the CRC to stdout with the command (using the
> + at file{sh} shell syntax):
> + at example
> +ffmpeg -i INPUT -f crc -
> + at end example

That this is shell syntax seems redundant to me.  Are you referring to
'-' being used to denote stdin?

Diego