[FFmpeg-devel] [PATCHv2] doc/demuxers: add some concat demuxer script examples

[Stefano Sabatini]

On date Tuesday 2016-01-26 09:09:16 +0100, Tobias Rapp encoded:
> On 25.01.2016 13:22, Nicolas George wrote:
> >Le decadi 30 nivôse, an CCXXIV, Tobias Rapp a écrit :
> >>Attached patch adds some example scripts for the concat demuxer to the
> >>documentation.
> >
> >Well, I maintain the code, not really the documentation.
> >
> >>>From 5ffc11e8139476d18cd2eaa28338adb0dda80999 Mon Sep 17 00:00:00 2001
> >>From: Tobias Rapp <t.rapp at noa-archive.com>
> >>Date: Tue, 19 Jan 2016 15:42:33 +0100
> >>Subject: [PATCH] doc/demuxers: add some concat demuxer script examples
> >>
> >>Signed-off-by: Tobias Rapp <t.rapp at noa-archive.com>
> >>---
> >>  doc/demuxers.texi | 21 +++++++++++++++++++++
> >>  1 file changed, 21 insertions(+)
> >>
> >>diff --git a/doc/demuxers.texi b/doc/demuxers.texi
> >>index fb1e4fb..3900272 100644
> >>--- a/doc/demuxers.texi
> >>+++ b/doc/demuxers.texi
> >>@@ -214,6 +214,27 @@ The default is 0.
> >>
> >>  @end table
> >>
> >>+ at subsection Examples
> >>+
> >
> >>+Example script which uses absolute filenames and includes some comments:
> >
> >I am not sure that "which" is the most idiomatic here, "that" sound better,
> >but I am not a native speaker.
> 
> I can also avoid which/that by "itemize"-ing the examples similar to
> other example sections within the documentation. Attached an updated
> version of the patch.
> 
> >>+ at example
> >>+# my first filename
> >>+file /mnt/share/file-1.wav
> >>+# my second filename including whitespace
> >>+file '/mnt/share/file 2.wav'
> >>+# my third filename including whitespace plus single quote
> >>+file '/mnt/share/file 3'\''.wav'
> >>+ at end example
> >>+
> >>+Example script which allows for input format auto-probing, uses safe filenames
> >>+and sets the duration of the first file:
> >>+ at example
> >>+ffconcat version 1.0
> >>+file file-1.wav
> >>+duration 20.0
> >>+file 'file 2.wav'
> >>+ at end example
> >>+
> >>  @section flv
> >>
> >>  Adobe Flash Video Format demuxer.
> >
> >No objection apart from that.
> 
> Regards,
> Tobias

> From 2faf6c05df62c69347091aa6254c2db796d19345 Mon Sep 17 00:00:00 2001
> From: Tobias Rapp <t.rapp at noa-archive.com>
> Date: Tue, 26 Jan 2016 09:02:51 +0100
> Subject: [PATCH] doc/demuxers: add some concat demuxer script examples
> 
> Signed-off-by: Tobias Rapp <t.rapp at noa-archive.com>
> ---
>  doc/demuxers.texi | 25 +++++++++++++++++++++++++
>  1 file changed, 25 insertions(+)
> 
> diff --git a/doc/demuxers.texi b/doc/demuxers.texi
> index fb1e4fb..02cd041 100644
> --- a/doc/demuxers.texi
> +++ b/doc/demuxers.texi
> @@ -214,6 +214,31 @@ The default is 0.
>  
>  @end table
>  
> + at subsection Examples
> +
> + at itemize
> + at item
> +Use absolute filenames and include some comments:
> + at example
> +# my first filename
> +file /mnt/share/file-1.wav
> +# my second filename including whitespace
> +file '/mnt/share/file 2.wav'
> +# my third filename including whitespace plus single quote
> +file '/mnt/share/file 3'\''.wav'
> + at end example
> +
> + at item
> +Allow for input format auto-probing, use safe filenames and set the duration of
> +the first file:

> + at example
> +ffconcat version 1.0
> +file file-1.wav
> +duration 20.0
> +file 'file 2.wav'
> + at end example
> + at end itemize

Nit: add an empty line after the "duration" directive, so that it's
clear that it applies to the first file.

LGTM otherwise, thanks.
-- 
FFmpeg = Fostering and Fancy Multimedia Patchable Elaborated Guru