diff mbox series

[FFmpeg-devel,3/3] doc/filters: mentions that whitespaces are ignored in the filtergraph specification

Message ID 20230326173401.56228-3-stefasab@gmail.com
State Accepted
Commit 5c1330798978cee5b4d7926bea611820b1019804
Headers show
Series [FFmpeg-devel,1/3] doc/filters/drawtext: clarify meaning of strftime format string | expand

Checks

Context Check Description
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Stefano Sabatini March 26, 2023, 5:34 p.m. UTC
Also provide example showing how to use this feature to improve filtergraph
readability.

Address issue:
http://trac.ffmpeg.org/ticket/8115
---
 doc/filters.texi | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

Comments

Gyan Doshi March 27, 2023, 4:36 a.m. UTC | #1
On 2023-03-26 11:04 pm, Stefano Sabatini wrote:
> Also provide example showing how to use this feature to improve filtergraph
> readability.

LGTM.

Regards,
Gyan

>
> Address issue:
> http://trac.ffmpeg.org/ticket/8115
> ---
>   doc/filters.texi | 17 +++++++++++++++++
>   1 file changed, 17 insertions(+)
>
> diff --git a/doc/filters.texi b/doc/filters.texi
> index 1c9d523340..889de8b11a 100644
> --- a/doc/filters.texi
> +++ b/doc/filters.texi
> @@ -214,6 +214,23 @@ In a complete filterchain all the unlabelled filter input and output
>   pads must be connected. A filtergraph is considered valid if all the
>   filter input and output pads of all the filterchains are connected.
>   
> +Leading and trailing whitespaces (space, tabs, or line feeds) separating tokens
> +in the filtergraph specification are ignored. This means that the filtergraph
> +can be expressed using empty lines and spaces to improve redability.
> +
> +For example, the filtergraph:
> +@example
> +testsrc,split[L1],hflip[L2];[L1][L2] hstack
> +@end example
> +
> +can be represented as:
> +@example
> +testsrc,
> +split [L1], hflip [L2];
> +
> +[L1][L2] hstack
> +@end example
> +
>   Libavfilter will automatically insert @ref{scale} filters where format
>   conversion is required. It is possible to specify swscale flags
>   for those automatically inserted scalers by prepending
Stefano Sabatini March 28, 2023, 10:31 p.m. UTC | #2
On date Monday 2023-03-27 10:06:19 +0530, Gyan Doshi wrote:
> 
> 
> On 2023-03-26 11:04 pm, Stefano Sabatini wrote:
> > Also provide example showing how to use this feature to improve filtergraph
> > readability.
> 
> LGTM.

Applied, thanks.
diff mbox series

Patch

diff --git a/doc/filters.texi b/doc/filters.texi
index 1c9d523340..889de8b11a 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -214,6 +214,23 @@  In a complete filterchain all the unlabelled filter input and output
 pads must be connected. A filtergraph is considered valid if all the
 filter input and output pads of all the filterchains are connected.
 
+Leading and trailing whitespaces (space, tabs, or line feeds) separating tokens
+in the filtergraph specification are ignored. This means that the filtergraph
+can be expressed using empty lines and spaces to improve redability.
+
+For example, the filtergraph:
+@example
+testsrc,split[L1],hflip[L2];[L1][L2] hstack
+@end example
+
+can be represented as:
+@example
+testsrc,
+split [L1], hflip [L2];
+
+[L1][L2] hstack
+@end example
+
 Libavfilter will automatically insert @ref{scale} filters where format
 conversion is required. It is possible to specify swscale flags
 for those automatically inserted scalers by prepending