Re: [PATCH v5 06/14] iio: magnetometer: yas530: Rename functions and registers

From: Andy Shevchenko <andy.shevchenko@gmail.com>
To: Jakob Hauser <jahau@rocketmail.com>
Cc: Jonathan Cameron <jic23@kernel.org>,
	Lars-Peter Clausen <lars@metafoo.de>,
	Linus Walleij <linus.walleij@linaro.org>,
	Hans de Goede <hdegoede@redhat.com>,
	linux-iio <linux-iio@vger.kernel.org>,
	devicetree <devicetree@vger.kernel.org>,
	phone-devel@vger.kernel.org,
	~postmarketos/upstreaming@lists.sr.ht
Subject: Re: [PATCH v5 06/14] iio: magnetometer: yas530: Rename functions and registers
Date: Mon, 8 Aug 2022 13:08:33 +0200	[thread overview]
Message-ID: <CAHp75Ve19nzSem+CCL6w77mkavSCW0LzrDTAWkfQUHJXy=QAoA@mail.gmail.com> (raw)
In-Reply-To: <ca008512c5196a377042cd71254dedad3668bb44.1659909060.git.jahau@rocketmail.com>

On Mon, Aug 8, 2022 at 1:03 AM Jakob Hauser <jahau@rocketmail.com> wrote:
>
> This is a preparation for adding YAS537 variant.

the YAS537

> Functions that are used only by YAS530, YAS532 and YAS533 are renamed from
> yas5xx to yas530. Same for the registers.
>
> To avoid part listing in function and registers names, the name of the first
> variant is used. Where appropriate, comments were added that these functions
> are used by more than one variant.
>
> Functions that will be used by all variants including YAS537 remain in the
> naming scheme yas5xx. Or YAS5XX for registers, respectively.

...

>  /**
> - * yas5xx_get_measure() - Measure a sample of all axis and process
> + * yas530_get_measure() - Measure a sample of all axis and process
>   * @yas5xx: The device state
>   * @to: Temperature out
>   * @xo: X axis out
>   * @yo: Y axis out
>   * @zo: Z axis out
>   * @return: 0 on success or error code

> + * Used by YAS530, YAS532 and YAS533

In this case (multi-line comment) the period should be added to the
sentence. Ditto for other similar cases.

>   */

Otherwise the change looks good. So, if you address these,
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>

-- 
With Best Regards,
Andy Shevchenko