Hi all,
After merging the sound-asoc tree, today's linux-next build (htmldocs)
produced this warning:
include/linux/int_log.h:1: warning: no structured comments found
Introduced by commit
f97fa3dcb2db ("lib/math: Move dvb_math.c into lib/math/int_log.c")
--
Cheers,
Stephen Rothwell
On Thu, Jul 13, 2023 at 12:16:27PM +1000, Stephen Rothwell wrote:
> Hi all,
>
> After merging the sound-asoc tree, today's linux-next build (htmldocs)
> produced this warning:
>
> include/linux/int_log.h:1: warning: no structured comments found
>
> Introduced by commit
>
> f97fa3dcb2db ("lib/math: Move dvb_math.c into lib/math/int_log.c")
Can you elaborate a bit, please?
Seems to me to be a false positive, or unveils a bug somewhere else.
--
With Best Regards,
Andy Shevchenko
On Thu, Jul 13, 2023 at 03:19:04PM +0300, Andy Shevchenko wrote:
> On Thu, Jul 13, 2023 at 12:16:27PM +1000, Stephen Rothwell wrote:
> > Hi all,
> >
> > After merging the sound-asoc tree, today's linux-next build (htmldocs)
> > produced this warning:
> >
> > include/linux/int_log.h:1: warning: no structured comments found
> >
> > Introduced by commit
> >
> > f97fa3dcb2db ("lib/math: Move dvb_math.c into lib/math/int_log.c")
>
> Can you elaborate a bit, please?
>
> Seems to me to be a false positive, or unveils a bug somewhere else.
Ah, now I understand. There is a header file that has descriptions but
EXPORT_SYMBOL. We have to drop keyword export from the index.
Thank you for the report, I'll cook the patch ASAP.
--
With Best Regards,
Andy Shevchenko
On Thu, Jul 13, 2023 at 03:41:09PM +0300, Andy Shevchenko wrote:
> On Thu, Jul 13, 2023 at 03:19:04PM +0300, Andy Shevchenko wrote:
> > On Thu, Jul 13, 2023 at 12:16:27PM +1000, Stephen Rothwell wrote:
> > > Hi all,
> > >
> > > After merging the sound-asoc tree, today's linux-next build (htmldocs)
> > > produced this warning:
> > >
> > > include/linux/int_log.h:1: warning: no structured comments found
> > >
> > > Introduced by commit
> > >
> > > f97fa3dcb2db ("lib/math: Move dvb_math.c into lib/math/int_log.c")
> >
> > Can you elaborate a bit, please?
> >
> > Seems to me to be a false positive, or unveils a bug somewhere else.
>
> Ah, now I understand. There is a header file that has descriptions but
> EXPORT_SYMBOL. We have to drop keyword export from the index.
>
> Thank you for the report, I'll cook the patch ASAP.
The [email protected] had been sent.
--
With Best Regards,
Andy Shevchenko
Hi Aall,
On Fri, 14 Jul 2023 12:18:55 +0300 Andy Shevchenko <[email protected]> wrote:
>
> On Thu, Jul 13, 2023 at 03:41:09PM +0300, Andy Shevchenko wrote:
> > On Thu, Jul 13, 2023 at 03:19:04PM +0300, Andy Shevchenko wrote:
> > > On Thu, Jul 13, 2023 at 12:16:27PM +1000, Stephen Rothwell wrote:
> > > >
> > > > After merging the sound-asoc tree, today's linux-next build (htmldocs)
> > > > produced this warning:
> > > >
> > > > include/linux/int_log.h:1: warning: no structured comments found
> > > >
> > > > Introduced by commit
> > > >
> > > > f97fa3dcb2db ("lib/math: Move dvb_math.c into lib/math/int_log.c")
> > >
> > > Can you elaborate a bit, please?
> > >
> > > Seems to me to be a false positive, or unveils a bug somewhere else.
> >
> > Ah, now I understand. There is a header file that has descriptions but
> > EXPORT_SYMBOL. We have to drop keyword export from the index.
> >
> > Thank you for the report, I'll cook the patch ASAP.
>
> The [email protected] had been sent.
But not yet applied by anyone :-(
--
Cheers,
Stephen Rothwell
On Mon, Jul 24, 2023 at 01:58:58PM +1000, Stephen Rothwell wrote:
> On Fri, 14 Jul 2023 12:18:55 +0300 Andy Shevchenko <[email protected]> wrote:
> > On Thu, Jul 13, 2023 at 03:41:09PM +0300, Andy Shevchenko wrote:
> > > On Thu, Jul 13, 2023 at 03:19:04PM +0300, Andy Shevchenko wrote:
> > > > On Thu, Jul 13, 2023 at 12:16:27PM +1000, Stephen Rothwell wrote:
> > > > >
> > > > > After merging the sound-asoc tree, today's linux-next build (htmldocs)
> > > > > produced this warning:
> > > > >
> > > > > include/linux/int_log.h:1: warning: no structured comments found
> > > > >
> > > > > Introduced by commit
> > > > >
> > > > > f97fa3dcb2db ("lib/math: Move dvb_math.c into lib/math/int_log.c")
> > > >
> > > > Can you elaborate a bit, please?
> > > >
> > > > Seems to me to be a false positive, or unveils a bug somewhere else.
> > >
> > > Ah, now I understand. There is a header file that has descriptions but
> > > EXPORT_SYMBOL. We have to drop keyword export from the index.
> > >
> > > Thank you for the report, I'll cook the patch ASAP.
> >
> > The [email protected] had been sent.
>
> But not yet applied by anyone :-(
Since the culprit went via ASoC tree, I think that tree is the best for the fix.
Mark, can you apply that, please?
--
With Best Regards,
Andy Shevchenko
On Mon, Jul 24, 2023 at 11:26:58AM +0300, Andy Shevchenko wrote:
> On Mon, Jul 24, 2023 at 01:58:58PM +1000, Stephen Rothwell wrote:
> > On Fri, 14 Jul 2023 12:18:55 +0300 Andy Shevchenko <[email protected]> wrote:
> > > The [email protected] had been sent.
For the benefit of those playing at home that's "Documentation:
core-api: Drop :export: for int_log.h".
> > But not yet applied by anyone :-(
> Since the culprit went via ASoC tree, I think that tree is the best for the fix.
> Mark, can you apply that, please?
Jon's usually fairly responsive, perhaps there's something worrying
there, though I do note you only sent it a bit more than a week ago.
On Mon, Jul 24, 2023 at 01:36:53PM +0100, Mark Brown wrote:
> On Mon, Jul 24, 2023 at 11:26:58AM +0300, Andy Shevchenko wrote:
> > On Mon, Jul 24, 2023 at 01:58:58PM +1000, Stephen Rothwell wrote:
> > > On Fri, 14 Jul 2023 12:18:55 +0300 Andy Shevchenko <[email protected]> wrote:
>
> > > > The [email protected] had been sent.
>
> For the benefit of those playing at home that's "Documentation:
> core-api: Drop :export: for int_log.h".
>
> > > But not yet applied by anyone :-(
>
> > Since the culprit went via ASoC tree, I think that tree is the best for the fix.
> > Mark, can you apply that, please?
>
> Jon's usually fairly responsive, perhaps there's something worrying
> there,
Hmm... maybe my understanding of the :export: is wrong? Or what do you suggest?
> though I do note you only sent it a bit more than a week ago.
I fully aware of that and you can see that this reply has been induced by
the ping from Stephen.
--
With Best Regards,
Andy Shevchenko
On Mon, Jul 24, 2023 at 04:05:34PM +0300, Andy Shevchenko wrote:
> On Mon, Jul 24, 2023 at 01:36:53PM +0100, Mark Brown wrote:
> > Jon's usually fairly responsive, perhaps there's something worrying
> > there,
> Hmm... maybe my understanding of the :export: is wrong? Or what do you suggest?
I have no idea what any of that is doing. I'm hoping Jon does.
> > though I do note you only sent it a bit more than a week ago.
> I fully aware of that and you can see that this reply has been induced by
> the ping from Stephen.
Sure, but that means that it's possible he's just not got round to it
yet rather than that there's a problem.
+Cc: Jon
On Mon, Jul 24, 2023 at 02:11:00PM +0100, Mark Brown wrote:
> On Mon, Jul 24, 2023 at 04:05:34PM +0300, Andy Shevchenko wrote:
> > On Mon, Jul 24, 2023 at 01:36:53PM +0100, Mark Brown wrote:
>
> > > Jon's usually fairly responsive, perhaps there's something worrying
> > > there,
>
> > Hmm... maybe my understanding of the :export: is wrong? Or what do you suggest?
>
> I have no idea what any of that is doing. I'm hoping Jon does.
Okay, so far we are waiting for his reply...
> > > though I do note you only sent it a bit more than a week ago.
>
> > I fully aware of that and you can see that this reply has been induced by
> > the ping from Stephen.
>
> Sure, but that means that it's possible he's just not got round to it
> yet rather than that there's a problem.
--
With Best Regards,
Andy Shevchenko
Andy Shevchenko <[email protected]> writes:
> +Cc: Jon
>
> On Mon, Jul 24, 2023 at 02:11:00PM +0100, Mark Brown wrote:
>> On Mon, Jul 24, 2023 at 04:05:34PM +0300, Andy Shevchenko wrote:
>> > On Mon, Jul 24, 2023 at 01:36:53PM +0100, Mark Brown wrote:
>>
>> > > Jon's usually fairly responsive, perhaps there's something worrying
>> > > there,
>>
>> > Hmm... maybe my understanding of the :export: is wrong? Or what do you suggest?
>>
>> I have no idea what any of that is doing. I'm hoping Jon does.
>
> Okay, so far we are waiting for his reply...
Sorry, it took me a bit to reconstruct why I hadn't applied this .. the
simple fact is that it doesn't apply to docs-next.
include/linux/int_log.h doesn't exist in mainline, so the kernel-doc
directive to include from it doesn't either. All of that is introduced
in linux-next ... so the fix really needs to take the same path that the
rest of the changes did.
I guess I'd just assumed that was going to happen and didn't reply,
apologies for that.
Feel free to add:
Acked-by: Jonathan Corbet <[email protected]>
if you feel so inclined.
Thanks,
jon