Re: [FFmpeg-devel] [PATCH 2/2] docs: Add documentation about YAML output writer

From: Stefano Sabatini <stefasab@gmail.com>
To: FFmpeg development discussions and patches <ffmpeg-devel@ffmpeg.org>
Cc: softworkz <softworkz@hotmail.com>
Subject: Re: [FFmpeg-devel] [PATCH 2/2] docs: Add documentation about YAML output writer
Date: Sat, 8 Mar 2025 16:05:54 +0100
Message-ID: <Z8xc0p8sePnCUJP8@mariano> (raw)
In-Reply-To: <e031f9c913ed0a2204d42701517792c4f97e3d72.1739995676.git.ffmpegagent@gmail.com>

On date Wednesday 2025-02-19 20:07:56 +0000, softworkz wrote:
> From: softworkz <softworkz@hotmail.com>
> 
> Signed-off-by: softworkz <softworkz@hotmail.com>
> ---
>  doc/ffprobe.texi | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
> 
> diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi
> index ceedc8793b..106d865e18 100644
> --- a/doc/ffprobe.texi
> +++ b/doc/ffprobe.texi
> @@ -626,6 +626,22 @@ This option automatically sets @option{fully_qualified} to 1.
>  
>  For more information about the XML format, see
>  @url{https://www.w3.org/XML/}.
> +
> +@section yaml
> +YAML based format.
> +
> +Each section is printed using YAML notation.
> +
> +The description of the accepted options follows.
> +
> +@table @option
> +
> +@item blank_lines
> +If set to 1, blank lines are inserted between sections for
> +better readability. Default value is 1.
> +@end table
> +
> +For more information about YAML, see @url{https://yaml.org/}.

I'd move this note before the options description.

LGTM otherwise.
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".