Skip to contentSkip to conversation

linux-next: build warning after merge of the v4l-dvb-next tree

PATCH In review Stephen Rothwell 3 participants 4 messages Feb 2, 2024

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

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")

Signature · 2 lines
Cheers,
Stephen Rothwell
#1 lore raw

PATCH 1/1 media: v4l: Fix link frequency helper's kernel-doc

Fix kernel-doc indentation for v4l2_link_freq_to_bitmap().

Fixes a68e88e2cf9e ("media: v4l: Add a helper for setting up link-frequencies control")

---
Thanks for reporting this, Stephen.

 include/media/v4l2-common.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/media/v4l2-common.h +1 -1
index cd2163f24f8a..602738f7741e 100644
@@ -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,
Signature · 1 line
2.39.2
#2 lore raw

Re: [PATCH 1/1] media: v4l: Fix link frequency helper's kernel-doc

Em Fri, 2 Feb 2024 08:40:07 +0200
Sakari Ailus <[email protected]> escreveu:

Quoted 16 lines

Fix kernel-doc indentation for v4l2_link_freq_to_bitmap().

Fixes a68e88e2cf9e ("media: v4l: Add a helper for setting up link-frequencies control")

---
Thanks for reporting this, Stephen.

 include/media/v4l2-common.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/media/v4l2-common.h +0 -0
index cd2163f24f8a..602738f7741e 100644

include/media/v4l2-common.h u32 v4l2_fraction_to_interval(u32 numerator, u32 denominator); · line 569

Quoted 8 lines
include/media/v4l2-common.h +1 -1
@@ -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

#3 lore raw

Re: [PATCH 1/1] media: v4l: Fix link frequency helper's kernel-doc

Hi Mauro,

Quoted 43 lines · Mauro Carvalho Chehab

Em Fri, 2 Feb 2024 08:40:07 +0200
Sakari Ailus <[email protected]> escreveu:

Quoted 16 lines

Fix kernel-doc indentation for v4l2_link_freq_to_bitmap().

Fixes a68e88e2cf9e ("media: v4l: Add a helper for setting up link-frequencies control")

---
Thanks for reporting this, Stephen.

 include/media/v4l2-common.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/media/v4l2-common.h +0 -0
index cd2163f24f8a..602738f7741e 100644

include/media/v4l2-common.h u32 v4l2_fraction_to_interval(u32 numerator, u32 denominator); · line 569

Quoted 8 lines
include/media/v4l2-common.h +1 -1
@@ -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.

Quoted 2 lines

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/[email protected]/T/#t>

So this one can be ignored.

Signature · 3 lines
Regards,

Sakari Ailus