From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.1 (2015-04-28) on archive.lwn.net X-Spam-Level: X-Spam-Status: No, score=-5.8 required=5.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=unavailable autolearn_force=no version=3.4.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by archive.lwn.net (Postfix) with ESMTP id 375467E22E for ; Fri, 13 Apr 2018 12:14:05 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752223AbeDMMOE (ORCPT ); Fri, 13 Apr 2018 08:14:04 -0400 Received: from mx2.suse.de ([195.135.220.15]:43125 "EHLO mx2.suse.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751847AbeDMMOD (ORCPT ); Fri, 13 Apr 2018 08:14:03 -0400 X-Virus-Scanned: by amavisd-new at test-mx.suse.de Received: from relay1.suse.de (charybdis-ext.suse.de [195.135.220.254]) by mx2.suse.de (Postfix) with ESMTP id 185E1AE75; Fri, 13 Apr 2018 12:14:02 +0000 (UTC) Date: Fri, 13 Apr 2018 14:13:59 +0200 From: Jean Delvare To: Wolfram Sang Cc: Sam Hansen , linux-i2c@vger.kernel.org, corbet@lwn.net, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH] Documentation/i2c: sync docs with current state of i2c-tools. Message-ID: <20180413141359.793919fb@endymion> In-Reply-To: <20180412222457.x4jdwt27ylgi74o3@katana> References: <20180412213342.138010-1-hansens@google.com> <20180412222457.x4jdwt27ylgi74o3@katana> Organization: SUSE Linux X-Mailer: Claws Mail 3.13.2 (GTK+ 2.24.31; x86_64-suse-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org Hi Wolfram, Sam, On Fri, 13 Apr 2018 00:24:57 +0200, Wolfram Sang wrote: > On Thu, Apr 12, 2018 at 02:33:42PM -0700, Sam Hansen wrote: > > Currently, Documentation/i2c/dev-interface describes the use of i2c_smbus_* > > helper routines as static inlined functions provided by linux/i2c-dev.h. Work > > has been done to refactor the linux/i2c-dev.h file in the i2c-tools project > > out into its own library. As a result, these docs have become stale. > > Thanks for fixing this! > > > This patch corrects the discrepancy and directs the reader to the i2c-tools > > project for more information. Additionally, some trailing-whitespace cleanups > > were made. > > Minor nit: Having the whitespace changes in a seperate patch is a tad > easier to review. > > > - /* Using I2C Write, equivalent of > > + /* Using I2C Write, equivalent of > > i2c_smbus_write_word_data(file, reg, 0x6543) */ > > Maybe change to Kernel coding style comments while here? > > > - Not meant to be called directly; instead, use the access functions > > - below. > > + If possible, use the provided i2c_smbus_* methods described below in favor > > + of issuing direct ioctls. > > Why this change? I'm also not sure if "in favor of" is right. "instead of" would sound better to me, but I'm no native English speaker, I could be wrong. > > -The above functions are all inline functions, that resolve to calls to > > -the i2c_smbus_access function, that on its turn calls a specific ioctl > > -with the data in a specific format. Read the source code if you > > -want to know what happens behind the screens. > > +The above functions are made available by linking against the libi2c library, > > +which is provided by the i2c-tools project. See: > > +https://git.kernel.org/pub/scm/utils/i2c-tools/i2c-tools.git/. > > This is fine with me. Maybe Jean has a comment on this? Fixing the documentation is always welcome, thanks Sam for stepping in. However we really want separate patches for whitespace fixes and actual contents change, as Wolfram already mentioned above. -- Jean Delvare SUSE L3 Support -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html