Received-SPF: pass (google.com: domain of linux-kernel+bounces-49900-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
Date: Fri, 2 Feb 2024 14:30:27 +0100
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
Message-ID: <20240202143027.21fe3f5b@coco.lan>
In-Reply-To: <20240202064007.50545-1-sakari.ailus@linux.intel.com>
References: <20240202145412.336db5b2@canb.auug.org.au>
	<20240202064007.50545-1-sakari.ailus@linux.intel.com>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit

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