diff mbox series

[FFmpeg-devel] doc/filters: Change rdiv (vf_convolution) documentation to reflect actual behavior

Message ID 20240314164745.75106-1-chen.stonechen@gmail.com
State New
Headers show
Series [FFmpeg-devel] doc/filters: Change rdiv (vf_convolution) documentation to reflect actual behavior | expand

Checks

Context Check Description
yinshiyou/make_loongarch64 success Make finished
yinshiyou/make_fate_loongarch64 fail Make fate failed
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Stone Chen March 14, 2024, 4:47 p.m. UTC
The documentation correctly states that the rdiv is a multiplier but incorrectly states the default behavior is to multiply by the sum of all matrix elements - it multiplies by 1/sum.

This changes the documentation to match the code.

Address trac #10889
---
 doc/filters.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Marton Balint March 16, 2024, 9:05 p.m. UTC | #1
On Thu, 14 Mar 2024, Stone Chen wrote:

> The documentation correctly states that the rdiv is a multiplier but incorrectly states the default behavior is to multiply by the sum of all matrix elements - it multiplies by 1/sum.
>
> This changes the documentation to match the code.
>
> Address trac #10889
> ---
> doc/filters.texi | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/doc/filters.texi b/doc/filters.texi
> index e0436a5755..913365671d 100644
> --- a/doc/filters.texi
> +++ b/doc/filters.texi
> @@ -10497,7 +10497,7 @@ and from 1 to 49 odd number of signed integers in @var{row} mode.
> @item 2rdiv
> @item 3rdiv
> Set multiplier for calculated value for each plane.
> -If unset or 0, it will be sum of all matrix elements.
> +If unset or 0, it will be 1/sum of all matrix elements.
>
> @item 0bias
> @item 1bias
> -- 
> 2.44.0
>

Will apply.

Thanks,
Marton
diff mbox series

Patch

diff --git a/doc/filters.texi b/doc/filters.texi
index e0436a5755..913365671d 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -10497,7 +10497,7 @@  and from 1 to 49 odd number of signed integers in @var{row} mode.
 @item 2rdiv
 @item 3rdiv
 Set multiplier for calculated value for each plane.
-If unset or 0, it will be sum of all matrix elements.
+If unset or 0, it will be 1/sum of all matrix elements.
 
 @item 0bias
 @item 1bias