| Message ID | 20240202064007.50545-1-sakari.ailus@linux.intel.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [1/1] media: v4l: Fix link frequency helper's kernel-doc | expand |
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
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.
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,
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(-)