[FFmpeg-devel] [PATCH] doc/ffmpeg: slightly rework introductory examples

[Gyan Doshi]

On 2023-03-27 05:52 am, Stefano Sabatini wrote:
> In particular, add a sentence to introduce the example, and add a simpler starting example.
>
> Address issue:
> http://trac.ffmpeg.org/ticket/8730
> ---
>   doc/ffmpeg.texi | 16 ++++++++++++----
>   1 file changed, 12 insertions(+), 4 deletions(-)
>
> diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
> index adfc2726ff..68a6bc6e22 100644
> --- a/doc/ffmpeg.texi
> +++ b/doc/ffmpeg.texi
> @@ -49,22 +49,30 @@ Do not mix input and output files -- first specify all input files, then all
>   output files. Also do not mix options which belong to different files. All
>   options apply ONLY to the next input or output file and are reset between files.
>   
> +Some simple examples follow.
> +
>   @itemize
>   @item
> -To set the video bitrate of the output file to 64 kbit/s:
> +Convert an input media file to a different format:
> + at example
> +ffmpeg -i input.avi output.avi

It's not clear that the output is a different format.
A different extension, maybe.

Regards,
Gyan


> + at end example
> +
> + at item
> +Set the video bitrate of the output file to 64 kbit/s:
>   @example
>   ffmpeg -i input.avi -b:v 64k -bufsize 64k output.avi
>   @end example
>   
>   @item
> -To force the frame rate of the output file to 24 fps:
> +Force the frame rate of the output file to 24 fps:
>   @example
>   ffmpeg -i input.avi -r 24 output.avi
>   @end example
>   
>   @item
> -To force the frame rate of the input file (valid for raw formats only)
> -to 1 fps and the frame rate of the output file to 24 fps:
> +Force the frame rate of the input file (valid for raw formats only) to 1 fps and
> +the frame rate of the output file to 24 fps:
>   @example
>   ffmpeg -r 1 -i input.m2v -r 24 output.avi
>   @end example