[FFmpeg-devel] [PATCH] ffprobe: create a dedicated "Writers" section in the manual

[Clément Bœsch]

On Sun, Oct 02, 2011 at 12:40:53PM +0200, Stefano Sabatini wrote:
> Also update documentation related to the output format.
> ---
>  doc/ffprobe.texi |   51 ++++++++++++++++++++++++++++++++++++++++-----------
>  1 files changed, 40 insertions(+), 11 deletions(-)
> 
> diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi
> index a5d5df8..59643c2 100644
> --- a/doc/ffprobe.texi
> +++ b/doc/ffprobe.texi
> @@ -42,18 +42,11 @@ for specifying which information to display, and for setting how
>  ffprobe will show it.
>  
>  ffprobe output is designed to be easily parsable by a textual filter,
> -and consists of one or more sections of the form:
> - at example
> -[SECTION]
> -key1=val1
> -...
> -keyN=valN
> -[/SECTION]
> - at end example
> +and consists of one or more sections of a form defined by the selected
> +writer, which is specified by the @option{print_format} option.
>  
>  Metadata tags stored in the container or in the streams are recognized
> -and printed in the corresponding "FORMAT" or "STREAM" section, and
> -are prefixed by the string "TAG:".
> +and printed in the corresponding "FORMAT" or "STREAM" section.
>  
>  @c man end
>  
> @@ -89,7 +82,8 @@ options "-unit -prefix -byte_binary_prefix -sexagesimal".
>  
>  @item -print_format @var{format}
>  Set the output printing format.
> -Current available formats are "default" and "json".
> +
> +See the Writers section below.

I think we should add an example ASAP instead of driving the user nuts
in a large lexixal soup between chapters:

    Example:
      -print_format json

    For more details on the available printing output, see the Writers
    section below.

[...]

-- 
Clément B.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20111003/b4ef95cc/attachment.asc>