* linux-next: build warning after merge of the v4l-dvb-next tree
@ 2024-02-02 3:54 Stephen Rothwell
2024-02-02 6:40 ` [PATCH 1/1] media: v4l: Fix link frequency helper's kernel-doc Sakari Ailus
0 siblings, 1 reply; 7+ messages in thread
From: Stephen Rothwell @ 2024-02-02 3:54 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Sakari Ailus, Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 516 bytes --]
Hi all,
After merging the v4l-dvb-next tree, today's linux-next build (htmldocs)
produced this warning:
Documentation/driver-api/media/v4l2-common:6: include/media/v4l2-common.h:566: ERROR: Unexpected indentation.
Documentation/driver-api/media/v4l2-common:6: include/media/v4l2-common.h:567: WARNING: Block quote ends without a blank line; unexpected unindent.
Introduced by commit
a68e88e2cf9e ("media: v4l: Add a helper for setting up link-frequencies control")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH 1/1] media: v4l: Fix link frequency helper's kernel-doc
2024-02-02 3:54 linux-next: build warning after merge of the v4l-dvb-next tree Stephen Rothwell
@ 2024-02-02 6:40 ` Sakari Ailus
2024-02-02 13:30 ` Mauro Carvalho Chehab
0 siblings, 1 reply; 7+ messages in thread
From: Sakari Ailus @ 2024-02-02 6:40 UTC (permalink / raw)
To: linux-media
Cc: Mauro Carvalho Chehab, Stephen Rothwell, linux-kernel, linux-next
Fix kernel-doc indentation for v4l2_link_freq_to_bitmap().
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Fixes: a68e88e2cf9e ("media: v4l: Add a helper for setting up link-frequencies control")
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
Thanks for reporting this, Stephen.
include/media/v4l2-common.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/media/v4l2-common.h b/include/media/v4l2-common.h
index cd2163f24f8a..602738f7741e 100644
--- a/include/media/v4l2-common.h
+++ b/include/media/v4l2-common.h
@@ -563,7 +563,7 @@ u32 v4l2_fraction_to_interval(u32 numerator, u32 denominator);
* Return values:
* 0: Success
* -ENOENT: No match found between driver-supported link frequencies and
- * those available in firmware.
+ * those available in firmware.
* -ENODATA: No link frequencies were specified in firmware.
*/
int v4l2_link_freq_to_bitmap(struct device *dev, const u64 *fw_link_freqs,
--
2.39.2
^ permalink raw reply related [flat|nested] 7+ messages in thread
* Re: [PATCH 1/1] media: v4l: Fix link frequency helper's kernel-doc
2024-02-02 6:40 ` [PATCH 1/1] media: v4l: Fix link frequency helper's kernel-doc Sakari Ailus
@ 2024-02-02 13:30 ` Mauro Carvalho Chehab
2024-02-02 13:41 ` Sakari Ailus
0 siblings, 1 reply; 7+ messages in thread
From: Mauro Carvalho Chehab @ 2024-02-02 13:30 UTC (permalink / raw)
To: Sakari Ailus; +Cc: linux-media, Stephen Rothwell, linux-kernel, linux-next
Em Fri, 2 Feb 2024 08:40:07 +0200
Sakari Ailus <sakari.ailus@linux.intel.com> escreveu:
> Fix kernel-doc indentation for v4l2_link_freq_to_bitmap().
>
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Fixes: a68e88e2cf9e ("media: v4l: Add a helper for setting up link-frequencies control")
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> ---
> Thanks for reporting this, Stephen.
>
> include/media/v4l2-common.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/media/v4l2-common.h b/include/media/v4l2-common.h
> index cd2163f24f8a..602738f7741e 100644
> --- a/include/media/v4l2-common.h
> +++ b/include/media/v4l2-common.h
> @@ -563,7 +563,7 @@ u32 v4l2_fraction_to_interval(u32 numerator, u32 denominator);
> * Return values:
> * 0: Success
> * -ENOENT: No match found between driver-supported link frequencies and
> - * those available in firmware.
> + * those available in firmware.
> * -ENODATA: No link frequencies were specified in firmware.
> */
> int v4l2_link_freq_to_bitmap(struct device *dev, const u64 *fw_link_freqs,
This won't do what's expected at documentation, as Sphinx will just
fold everything into a single paragraph, like:
"0: Success -ENOENT: No match found between driver-supported link frequencies and those available in firmware. -ENODATA: No link frequencies were specified in firmware."
Maybe you could try using (untested):
* Return values:
*
* * 0: success
* * -ENOENT: No match found between driver-supported link frequencies and
* those available in firmware.
* * - ENODATA: No link frequencies were specified in firmware.
Please test it and see if the "make htmldocs" output will be what it would
be expected.
Regards,
Mauro
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH 1/1] media: v4l: Fix link frequency helper's kernel-doc
2024-02-02 13:30 ` Mauro Carvalho Chehab
@ 2024-02-02 13:41 ` Sakari Ailus
0 siblings, 0 replies; 7+ messages in thread
From: Sakari Ailus @ 2024-02-02 13:41 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: linux-media, Stephen Rothwell, linux-kernel, linux-next
Hi Mauro,
On Fri, Feb 02, 2024 at 02:30:27PM +0100, Mauro Carvalho Chehab wrote:
> Em Fri, 2 Feb 2024 08:40:07 +0200
> Sakari Ailus <sakari.ailus@linux.intel.com> escreveu:
>
> > Fix kernel-doc indentation for v4l2_link_freq_to_bitmap().
> >
> > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> > Fixes: a68e88e2cf9e ("media: v4l: Add a helper for setting up link-frequencies control")
> > Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> > ---
> > Thanks for reporting this, Stephen.
> >
> > include/media/v4l2-common.h | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/include/media/v4l2-common.h b/include/media/v4l2-common.h
> > index cd2163f24f8a..602738f7741e 100644
> > --- a/include/media/v4l2-common.h
> > +++ b/include/media/v4l2-common.h
> > @@ -563,7 +563,7 @@ u32 v4l2_fraction_to_interval(u32 numerator, u32 denominator);
> > * Return values:
> > * 0: Success
> > * -ENOENT: No match found between driver-supported link frequencies and
> > - * those available in firmware.
> > + * those available in firmware.
> > * -ENODATA: No link frequencies were specified in firmware.
> > */
> > int v4l2_link_freq_to_bitmap(struct device *dev, const u64 *fw_link_freqs,
>
> This won't do what's expected at documentation, as Sphinx will just
> fold everything into a single paragraph, like:
>
> "0: Success -ENOENT: No match found between driver-supported link frequencies and those available in firmware. -ENODATA: No link frequencies were specified in firmware."
>
> Maybe you could try using (untested):
>
>
> * Return values:
> *
> * * 0: success
> * * -ENOENT: No match found between driver-supported link frequencies and
> * those available in firmware.
> * * - ENODATA: No link frequencies were specified in firmware.
>
> Please test it and see if the "make htmldocs" output will be what it would
> be expected.
Hans separately submitted a patch to address this better, it's here:
<URL:https://lore.kernel.org/linux-media/ZbysG-sUu9jf3fwQ@kekkonen.localdomain/T/#t>
So this one can be ignored.
--
Regards,
Sakari Ailus
^ permalink raw reply [flat|nested] 7+ messages in thread
* linux-next: build warning after merge of the v4l-dvb-next tree
@ 2023-05-15 4:01 Stephen Rothwell
0 siblings, 0 replies; 7+ messages in thread
From: Stephen Rothwell @ 2023-05-15 4:01 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Athanasios Oikonomou, Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 864 bytes --]
Hi all,
After merging the v4l-dvb-next tree, today's linux-next build (htmldocs)
produced this warning:
Documentation/output/frontend.h.rst:6: WARNING: undefined label: 'fec-11-45'
Documentation/output/frontend.h.rst:6: WARNING: undefined label: 'fec-4-15'
Documentation/output/frontend.h.rst:6: WARNING: undefined label: 'fec-14-45'
Documentation/output/frontend.h.rst:6: WARNING: undefined label: 'fec-7-15'
Documentation/output/frontend.h.rst:6: WARNING: undefined label: 'fec-11-45'
Documentation/output/frontend.h.rst:6: WARNING: undefined label: 'fec-4-15'
Documentation/output/frontend.h.rst:6: WARNING: undefined label: 'fec-14-45'
Documentation/output/frontend.h.rst:6: WARNING: undefined label: 'fec-7-15'
Introduced by commit
1825788e2a96 ("media: dvb: add missing DVB-S2X FEC parameter values")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: linux-next: build warning after merge of the v4l-dvb-next tree
2022-11-09 5:20 Stephen Rothwell
@ 2022-11-09 14:50 ` Benjamin MUGNIER
0 siblings, 0 replies; 7+ messages in thread
From: Benjamin MUGNIER @ 2022-11-09 14:50 UTC (permalink / raw)
To: Stephen Rothwell, Mauro Carvalho Chehab
Cc: Sakari Ailus, Linux Kernel Mailing List, Linux Next Mailing List
Hi Stephen,
Yes, I apologize for this.
This is fixed by this patch:
https://www.spinics.net/lists/linux-media/msg221143.
On 11/9/22 06:20, Stephen Rothwell wrote:
> Hi all,
>
> After merging the v4l-dvb-next tree, today's linux-next build (htmldocs)
> produced this warning:
>
> Documentation/userspace-api/media/drivers/st-vgxy61.rst: WARNING: document isn't included in any toctree
>
> Introduced by commit
>
> 2378be892b6f ("media: Documentation: Add ST VGXY61 driver documentation")
>
--
Regards,
Benjamin
^ permalink raw reply [flat|nested] 7+ messages in thread
* linux-next: build warning after merge of the v4l-dvb-next tree
@ 2022-11-09 5:20 Stephen Rothwell
2022-11-09 14:50 ` Benjamin MUGNIER
0 siblings, 1 reply; 7+ messages in thread
From: Stephen Rothwell @ 2022-11-09 5:20 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Benjamin Mugnier, Sakari Ailus, Linux Kernel Mailing List,
Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 354 bytes --]
Hi all,
After merging the v4l-dvb-next tree, today's linux-next build (htmldocs)
produced this warning:
Documentation/userspace-api/media/drivers/st-vgxy61.rst: WARNING: document isn't included in any toctree
Introduced by commit
2378be892b6f ("media: Documentation: Add ST VGXY61 driver documentation")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 7+ messages in thread
end of thread, other threads:[~2024-02-02 13:48 UTC | newest]
Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-02-02 3:54 linux-next: build warning after merge of the v4l-dvb-next tree Stephen Rothwell
2024-02-02 6:40 ` [PATCH 1/1] media: v4l: Fix link frequency helper's kernel-doc Sakari Ailus
2024-02-02 13:30 ` Mauro Carvalho Chehab
2024-02-02 13:41 ` Sakari Ailus
-- strict thread matches above, loose matches on Subject: below --
2023-05-15 4:01 linux-next: build warning after merge of the v4l-dvb-next tree Stephen Rothwell
2022-11-09 5:20 Stephen Rothwell
2022-11-09 14:50 ` Benjamin MUGNIER
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).