From: Mauro Carvalho Chehab <mchehab@kernel•org>
To: Sakari Ailus <sakari.ailus@linux•intel.com>
Cc: linux-media@vger•kernel.org,
Stephen Rothwell <sfr@canb•auug.org.au>,
linux-kernel@vger•kernel.org, linux-next@vger•kernel.org
Subject: Re: [PATCH 1/1] media: v4l: Fix link frequency helper's kernel-doc
Date: Fri, 2 Feb 2024 14:30:27 +0100 [thread overview]
Message-ID: <20240202143027.21fe3f5b@coco.lan> (raw)
In-Reply-To: <20240202064007.50545-1-sakari.ailus@linux.intel.com>
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
next prev parent reply other threads:[~2024-02-02 13:30 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
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 [this message]
2024-02-02 13:41 ` Sakari Ailus
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240202143027.21fe3f5b@coco.lan \
--to=mchehab@kernel$(echo .)org \
--cc=linux-kernel@vger$(echo .)kernel.org \
--cc=linux-media@vger$(echo .)kernel.org \
--cc=linux-next@vger$(echo .)kernel.org \
--cc=sakari.ailus@linux$(echo .)intel.com \
--cc=sfr@canb$(echo .)auug.org.au \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox