From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3DAA0C3A5A7 for ; Thu, 8 Dec 2022 16:05:35 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229848AbiLHQFd (ORCPT ); Thu, 8 Dec 2022 11:05:33 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:51034 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229612AbiLHQFb (ORCPT ); Thu, 8 Dec 2022 11:05:31 -0500 Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 98CA59D2E6; Thu, 8 Dec 2022 08:05:30 -0800 (PST) Received: from [192.168.1.15] (91-154-32-225.elisa-laajakaista.fi [91.154.32.225]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 60C4E25B; Thu, 8 Dec 2022 17:05:27 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1670515528; bh=QWLlEdgzVfuNXMkoGAKaN0y9Ur+bmlx22FQ8K/0EgQM=; h=Date:Subject:To:Cc:References:From:In-Reply-To:From; b=RRWNwDoShHDB0lrSWIswvEn4+bCch6wO0vXQEmSKxoj03bCftQir6L9FDAWXE06Ud B7wldYXo+QRNOECs1dLvRQDRXPK4DIKFSiKX1VajC4plCsu+RVXnF6uh7gx8KcUDxv ccEDfN3Ba4kex/Ylvb0lZ9Hr/wY11sJ6QWbmbZEY= Message-ID: Date: Thu, 8 Dec 2022 18:05:24 +0200 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.4.2 Subject: Re: [PATCH v5 0/8] i2c-atr and FPDLink Content-Language: en-US To: Andy Shevchenko Cc: linux-media@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, linux-i2c@vger.kernel.org, Rob Herring , Krzysztof Kozlowski , Wolfram Sang , Luca Ceresoli , Matti Vaittinen , Mauro Carvalho Chehab , Peter Rosin , Liam Girdwood , Mark Brown , Sakari Ailus , Laurent Pinchart , Michael Tretter , Shawn Tu , Hans Verkuil , Mike Pagano , =?UTF-8?Q?Krzysztof_Ha=c5=82asa?= , Marek Vasut References: <20221208104006.316606-1-tomi.valkeinen@ideasonboard.com> <0340d15c-be0a-cd28-4149-7976896f8eb1@ideasonboard.com> From: Tomi Valkeinen In-Reply-To: Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-i2c@vger.kernel.org On 08/12/2022 17:58, Andy Shevchenko wrote: > On Thu, Dec 08, 2022 at 05:57:23PM +0200, Andy Shevchenko wrote: >> On Thu, Dec 08, 2022 at 04:40:58PM +0200, Tomi Valkeinen wrote: >>> On 08/12/2022 14:26, Andy Shevchenko wrote: >>>> On Thu, Dec 08, 2022 at 12:42:13PM +0200, Tomi Valkeinen wrote: >>>>> On 08/12/2022 12:39, Tomi Valkeinen wrote: > > ... > >>>>> /** >>>>> - * Helper to add I2C ATR features to a device driver. >>>>> + * struct i2c_atr - Represents the I2C ATR instance >>>>> */ >>>> >>>> This is incomplete. Have you run kernel doc validator against this file? >>> >>> What's kernel doc validator? Do you mean that it's incomplete and kernel doc >>> doesn't work correctly, or that there should be more information here? >>> >>> I don't get any errors/warnings from any tool I have used. But I agree it >>> looks a bit odd with only the name of the struct in the doc. >> >> ... >> >> $ scripts/kernel-doc -none -v include/linux/i2c.h >> include/linux/i2c.h:79: warning: No description found for return value of 'i2c_master_recv' >> include/linux/i2c.h:94: warning: No description found for return value of 'i2c_master_recv_dmasafe' >> include/linux/i2c.h:109: warning: No description found for return value of 'i2c_master_send' >> include/linux/i2c.h:124: warning: No description found for return value of 'i2c_master_send_dmasafe' >> 4 warnings > > Note, this is just example against existing file, not your case. Yes, I tested with scripts/kernel-doc, it doesn't give any warnings about i2c-atr.h. Tomi