[FFmpeg-devel] [PATCH] libavutil/doc: Changes in documentation due to changes to fixed_dsp

[James Almer]

On 05/06/15 3:20 PM, Michael Niedermayer wrote:
> On Fri, Jun 05, 2015 at 08:05:33PM +0200, Michael Niedermayer wrote:
>> On Fri, Jun 05, 2015 at 07:59:47PM +0200, Michael Niedermayer wrote:
>>> On Fri, Jun 05, 2015 at 10:04:54AM -0400, Ronald S. Bultje wrote:
>>>> Hi,
>>>>
>>>> On Fri, Jun 5, 2015 at 5:54 AM, Nedeljko Babic <nedeljko.babic at imgtec.com>
>>>> wrote:
>>>>
>>>>> New functions are added to fixed_dsp, so the documentation is changed
>>>>> accordingly.
>>>>>
>>>>> Signed-off-by: Nedeljko Babic <nedeljko.babic at imgtec.com>
>>>>> ---
>>>>>  doc/APIchanges      | 7 +++++++
>>>>>  libavutil/version.h | 2 +-
>>>>>  2 files changed, 8 insertions(+), 1 deletion(-)
>>>>>
>>>>> diff --git a/doc/APIchanges b/doc/APIchanges
>>>>> index 5c36dca..bcf4fe6 100644
>>>>> --- a/doc/APIchanges
>>>>> +++ b/doc/APIchanges
>>>>> @@ -15,6 +15,13 @@ libavutil:     2014-08-09
>>>>>
>>>>>  API changes, most recent first:
>>>>>
>>>>> +2015-06-05 - xxxxxxx - lavu  54.27.101 - fixed_dsp.h
>>>>> +  Add vector_fmul()
>>>>> +  Add vector_fmul_reverse()
>>>>> +  Add vector_fmul_add()
>>>>> +  Add scalarproduct_fixed()
>>>>> +  Add butterflies_fixed()
>>>>
>>>>
>>>> These functions are not part of our public API, are they?
>>>
>>> It appears that the header isnt installed currently, ill post a patch
>>> to correct that
>>
>> hmm, it seems thats not possible
>> it contains
>> #include "libavcodec/mathops.h"
>> which is not a public header and from libavcodec
>>
>> ill revert the addition to APIchanges
>>
>> nedeljko, can you fix that header so it can be installed or move the
>> content to libavcodec. Depending on what the people prefer
> 
> or as james pointed out on IRC
> <jamrial> does it need to be installed for that matter? it's essentially the same as float_dsp, and that one has always been internal
> 
> 
> i wonder if it shouldnt be renamed to AVPrivFixedDSPContext in that
> case then though

Considering other internal structs are called AVWhatever, including AVFloatDSPContext,
a name change is probably not necessary.

And unless there's an actual need for these functions to be used outside libav*, lets
stop at removing the APIchanges lines that were wrongly added. Anything else is just
making changes for no realgain.

> 
> anyway i have no strong oppinon on any of this, iam fine with any
> solution