Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) client-ip=23.128.96.37;
Date:   Tue, 24 Oct 2023 13:57:42 +0300
From:   Andy Shevchenko <andriy.shevchenko@linux.intel.com>
To:     Mika Westerberg <mika.westerberg@linux.intel.com>
Cc:     Raag Jadav <raag.jadav@intel.com>, rafael@kernel.org,
        len.brown@intel.com, robert.moore@intel.com, mark.rutland@arm.com,
        will@kernel.org, linux@roeck-us.net, Jonathan.Cameron@huawei.com,
        linux-acpi@vger.kernel.org, linux-kernel@vger.kernel.org,
        acpica-devel@lists.linuxfoundation.org, linux-gpio@vger.kernel.org,
        linux-arm-kernel@lists.infradead.org, linux-hwmon@vger.kernel.org,
        mallikarjunappa.sangannavar@intel.com, bala.senthil@intel.com
Subject: Re: [PATCH v3 1/6] ACPI: utils: Introduce acpi_dev_uid_match() for
 matching _UID
Message-ID: <ZTejJo6io91n7e4H@smile.fi.intel.com>
References: <20231024062018.23839-1-raag.jadav@intel.com>
 <20231024062018.23839-2-raag.jadav@intel.com>
 <20231024092839.GE3208943@black.fi.intel.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20231024092839.GE3208943@black.fi.intel.com>
Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo
Precedence: bulk

On Tue, Oct 24, 2023 at 12:28:39PM +0300, Mika Westerberg wrote:
> On Tue, Oct 24, 2023 at 11:50:13AM +0530, Raag Jadav wrote:

...

> > + * Returns:
> > + *  - %true if matches.
> > + *  - %false otherwise.
> 
> Nit: these actually do not get formatted like above so you can just
> write it as
> 
> Returns: %true in case UIDs match, %false otherwise.
> 
> If it is even needed, I think it is pretty obvious from the function
> name what it returns.

kernel-doc complains if there is no Return: section in the text.

-- 
With Best Regards,
Andy Shevchenko