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

[Anton Khirnov]

Quoting Stefano Sabatini (2023-03-29 01:22:23)
> On date Monday 2023-03-27 10:59:34 +0530, Gyan Doshi wrote:
> > 
> > 
> > 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.
> 
> Done with a fer more changes.
> 
> From a92d8f8152cce3e349d21732248c6ccdecd000df Mon Sep 17 00:00:00 2001
> From: Stefano Sabatini <stefasab at gmail.com>
> Date: Mon, 27 Mar 2023 02:22:28 +0200
> Subject: [PATCH 1/3] doc/ffmpeg: slightly rework introductory examples
> 
> In particular, add a sentence to introduce the example, and add a
> simpler starting example with no options.
> 
> Also use different format for input.avi and output.mp4, to convey
> that the conversion also works on the container format.
> 
> Address issue:
> http://trac.ffmpeg.org/ticket/8730
> ---
>  doc/ffmpeg.texi | 23 ++++++++++++++++-------
>  1 file changed, 16 insertions(+), 7 deletions(-)
> 
> diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
> index adfc2726ff..33dc271b8d 100644
> --- a/doc/ffmpeg.texi
> +++ b/doc/ffmpeg.texi
> @@ -49,24 +49,33 @@ 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, by re-encoding media streams
> +to the target format:

IMO 'to the target format' confuses people about what exactly 'format'
means and how does it relate to 'container' and 'codec' used elsewhere
in the manual. I'd just drop that part.

-- 
Anton Khirnov