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 9AF61C4332F for ; Thu, 8 Dec 2022 15:58:27 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229554AbiLHP60 (ORCPT ); Thu, 8 Dec 2022 10:58:26 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:45070 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229532AbiLHP6Z (ORCPT ); Thu, 8 Dec 2022 10:58:25 -0500 Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BE4BD4A581; Thu, 8 Dec 2022 07:58:24 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1670515104; x=1702051104; h=date:from:to:cc:subject:message-id:references: mime-version:in-reply-to; bh=HFHvTj2UxyZTR/3t9cajOIIUSSoBJRn2X/zqMgVxw4E=; b=T2yxe8iA3iP6ksojfo5i3dDAD5pFJ1AV73nuRcirw0oajr5XtfphoNo7 1kISGWJOm/3TI4Nw6WkaYIyJOqJMWTkGBvZDfFvufxBjQ2l0RGOUzHnO4 kwhi7s7gUuu/oDhBsXIhf36a2IIQflr89hoG1YtzP9hQtA4WPs1LGJGBO UGeZ4PwzyeTNLXvFpSFN49lqQqcs20NOIdxEjSKRLG0Dgdtco56fF7EA5 1MW+o6cRQQjmm6gbnI6yxhOsh5DDBlWbpZYgGqJMApYrK0LZDVIbEf5jr FXorunn38gUpVUI+kHpFSWiXueTYxwKF+f7WP4eQFl8EzzA7pwi7vDGLO w==; X-IronPort-AV: E=McAfee;i="6500,9779,10555"; a="344250837" X-IronPort-AV: E=Sophos;i="5.96,227,1665471600"; d="scan'208";a="344250837" Received: from fmsmga004.fm.intel.com ([10.253.24.48]) by fmsmga101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 08 Dec 2022 07:58:24 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6500,9779,10555"; a="715655563" X-IronPort-AV: E=Sophos;i="5.96,227,1665471600"; d="scan'208";a="715655563" Received: from smile.fi.intel.com ([10.237.72.54]) by fmsmga004.fm.intel.com with ESMTP; 08 Dec 2022 07:58:18 -0800 Received: from andy by smile.fi.intel.com with local (Exim 4.96) (envelope-from ) id 1p3JHr-006QgJ-0K; Thu, 08 Dec 2022 17:58:15 +0200 Date: Thu, 8 Dec 2022 17:58:14 +0200 From: Andy Shevchenko To: Tomi Valkeinen 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 , Krzysztof =?utf-8?Q?Ha=C5=82asa?= , Marek Vasut Subject: Re: [PATCH v5 0/8] i2c-atr and FPDLink Message-ID: References: <20221208104006.316606-1-tomi.valkeinen@ideasonboard.com> <0340d15c-be0a-cd28-4149-7976896f8eb1@ideasonboard.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo Precedence: bulk List-ID: X-Mailing-List: devicetree@vger.kernel.org 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. -- With Best Regards, Andy Shevchenko