diff mbox series

[FFmpeg-devel] Change rdiv (vf_convolution) documentation to reflect actual behavior

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

Checks

Context Check Description
yinshiyou/commit_msg_loongarch64 warning The first line of the commit message must start with a context terminated by a colon and a space, for example "lavu/opt: " or "doc: ".
andriy/commit_msg_x86 warning The first line of the commit message must start with a context terminated by a colon and a space, for example "lavu/opt: " or "doc: ".
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Stone Chen March 12, 2024, 10:36 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.
---
 doc/filters.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Marton Balint March 13, 2024, 8:26 a.m. UTC | #1 
On Tue, 12 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.

Please mention in the commit message the ticket number this patch fixes.

Thanks,
Marton


> ---
> 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
>
> _______________________________________________
> 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".
>
Stone Chen March 13, 2024, 4:03 p.m. UTC | #2 
On Wed, Mar 13, 2024 at 4:26 AM Marton Balint <cus@passwd.hu> wrote:

>
>
> On Tue, 12 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.
>
> Please mention in the commit message the ticket number this patch fixes.
>
> Thanks,
> Marton
>

Hi Marton,

I just noticed that the ticket was closed
https://trac.ffmpeg.org/ticket/10294 (Michael Koch's comment re: docs).

Should I open a new ticket?

Cheers
Stone


> > ---
> > 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
> >
> > _______________________________________________
> > 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".
> >
> _______________________________________________
> 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".
>
Marton Balint March 13, 2024, 7:23 p.m. UTC | #3 
On Wed, 13 Mar 2024, Stone Chen wrote:

> On Wed, Mar 13, 2024 at 4:26 AM Marton Balint <cus@passwd.hu> wrote:
>
>>
>>
>> On Tue, 12 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.
>>
>> Please mention in the commit message the ticket number this patch fixes.
>>
>> Thanks,
>> Marton
>>
>
> Hi Marton,
>
> I just noticed that the ticket was closed
> https://trac.ffmpeg.org/ticket/10294 (Michael Koch's comment re: docs).

There is a new ticket for the documentation issue, ticket #10889.

Please mention that in the message.

Thanks,
Marton

>
> Should I open a new ticket?
>
> Cheers
> Stone
>
>
>> > ---
>> > 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
>> >
>> > _______________________________________________
>> > 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".
>> >
>> _______________________________________________
>> 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".
>>
> _______________________________________________
> 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".
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