public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Andy Shevchenko <andriy.shevchenko@intel.com>
To: Hamdan Khan <hamdankhan212@gmail.com>
Cc: hansg@kernel.org, mchehab@kernel.org,
	sakari.ailus@linux.intel.com, andy@kernel.org,
	gregkh@linuxfoundation.org, linux-media@vger.kernel.org,
	linux-staging@lists.linux.dev, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] staging: media: atomisp: Fix typos and comments alignment issue in include/linux/* header files
Date: Sat, 29 Nov 2025 15:46:16 +0200	[thread overview]
Message-ID: <aSr5KCPq-euRiqo6@smile.fi.intel.com> (raw)
In-Reply-To: <20251129061228.6286-1-hamdankhan212@gmail.com>

On Sat, Nov 29, 2025 at 11:12:28AM +0500, Hamdan Khan wrote:
> This patch fixes minor comment and code alignment issues in
> atomisp/include/linux/*.h header files. Some of them were warnings
> generated by checkpatch.pl (missing * at the start of the line or */
> present in the same line)

...

> -	int matrix[3 * 3];	/* RGB2YUV Color matrix, signed
> -				   <13-fraction_bits>.<fraction_bits> */
> +	/* RGB2YUV Color matrix, signed
> +	 * <13-fraction_bits>.<fraction_bits>
> +	 */

/*
 * This comment has to follow the common rules for
 * multi-line comments. Use this as an example.
 */

...

> +	/*
> +	 * the frame containing the overlay data The overlay frame width should

This becomes even worse. Fix the English text properly.

>  	 * be the multiples of 2*ISP_VEC_NELEMS. The overlay frame height
>  	 * should be the multiples of 2.
>  	 */

...

>  	/* the overlay start x pixel position on output frame It should be the
> -	   multiples of 2*ISP_VEC_NELEMS. */
> +	 * multiples of 2*ISP_VEC_NELEMS.
> +	 */

The same as per two above comments.

...

>  	/* the overlay start y pixel position on output frame It should be the
> -	   multiples of 2. */
> +	 * multiples of 2.
> +	 */

Ditto.

>  	/* CSI2-MIPI specific format: YUV data.
>  	 */
> -	ATOMISP_INPUT_FORMAT_YUV420_8_SHIFT,  /* YUV420 8-bit (Chroma Shifted
> -						 Pixel Sampling) */
> -	ATOMISP_INPUT_FORMAT_YUV420_10_SHIFT, /* YUV420 8-bit (Chroma Shifted
> -						 Pixel Sampling) */
> +	ATOMISP_INPUT_FORMAT_YUV420_8_SHIFT,   /* YUV420 8-bit (Chroma Shifted
> +						* Pixel Sampling)
> +						*/
> +	ATOMISP_INPUT_FORMAT_YUV420_10_SHIFT,  /* YUV420 10-bit (Chroma Shifted
> +						* Pixel Sampling)
> +						*/

Still not good. Make the comments to lead the definitions and also fix

	/* CSI2-MIPI specific format: YUV data. */
	...
	/* YUV420 10-bit (Chroma Shifted Pixel Sampling) */
	ATOMISP_INPUT_FORMAT_YUV420_10_SHIFT,

>  	/* CSI2-MIPI specific format: Generic long packet data
>  	 */

As per above.

You need to fix _all_ of them, do not leave the job half done.

...

>  /*
> - *  Sensor of external ISP can send multiple streams with different mipi data
> + * Sensor of external ISP can send multiple streams with different mipi data

MIPI

>   * type in the same virtual channel. This information needs to come from the
>   * sensor or external ISP

The sentence misses period at the end.

>   */

...

>  	/* Sensor driver fills ch_id with the id
> -	   of the virtual channel. */
> +	 * of the virtual channel.
> +	 */

>  	/* Tells how many streams in this virtual channel. If 0 ignore rest
> -	 * and the input format will be from mipi_info */
> +	 * and the input format will be from mipi_info
> +	 */

> -	/*
> -	 * if more isys_configs is more than 0, sensor needs to configure the
> +	/* If isys_configs is more than 0, sensor needs to configure the
>  	 * input format differently. width and height can be 0. If width and
>  	 * height is not zero, then the corresponding data needs to be set
>  	 */

All the above must be fixed properly.

...

TL:DR; this patch needs much more work. Take your time, the driver
is not so small. OTOH you can take one part of it and do this there.
I dunno if fixing one header subfolder is good enough, we may start
from it, but again, fix all problems, don't leave it in semi-baked
state.

-- 
With Best Regards,
Andy Shevchenko



  reply	other threads:[~2025-11-29 13:46 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-29  6:12 [PATCH] staging: media: atomisp: Fix typos and comments alignment issue in include/linux/* header files Hamdan Khan
2025-11-29 13:46 ` Andy Shevchenko [this message]
  -- strict thread matches above, loose matches on Subject: below --
2025-11-15 15:18 Hamdan Khan

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=aSr5KCPq-euRiqo6@smile.fi.intel.com \
    --to=andriy.shevchenko@intel.com \
    --cc=andy@kernel.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=hamdankhan212@gmail.com \
    --cc=hansg@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=linux-staging@lists.linux.dev \
    --cc=mchehab@kernel.org \
    --cc=sakari.ailus@linux.intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
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