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 X-Spam-Level: X-Spam-Status: No, score=-8.2 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS, USER_AGENT_SANE_2 autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id D4F03C33CB1 for ; Mon, 20 Jan 2020 09:27:37 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id B11B4207FF for ; Mon, 20 Jan 2020 09:27:37 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726417AbgATJ1e convert rfc822-to-8bit (ORCPT ); Mon, 20 Jan 2020 04:27:34 -0500 Received: from mx2.suse.de ([195.135.220.15]:46644 "EHLO mx2.suse.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726130AbgATJ1d (ORCPT ); Mon, 20 Jan 2020 04:27:33 -0500 X-Virus-Scanned: by amavisd-new at test-mx.suse.de Received: from relay2.suse.de (unknown [195.135.220.254]) by mx2.suse.de (Postfix) with ESMTP id BD255AD85; Mon, 20 Jan 2020 09:27:31 +0000 (UTC) Date: Mon, 20 Jan 2020 10:27:30 +0100 From: Jean Delvare To: Luca Ceresoli Cc: linux-doc@vger.kernel.org, linux-i2c@vger.kernel.org, Wolfram Sang , Peter Rosin , linux-kernel@vger.kernel.org Subject: Re: [PATCH 02/26] docs: i2c: summary: extend introduction Message-ID: <20200120102730.4eb9116b@endymion> In-Reply-To: <20200105225012.11701-2-luca@lucaceresoli.net> References: <20200105224006.10321-1-luca@lucaceresoli.net> <20200105225012.11701-1-luca@lucaceresoli.net> <20200105225012.11701-2-luca@lucaceresoli.net> Organization: SUSE Linux X-Mailer: Claws Mail 3.17.4 (GTK+ 2.24.32; x86_64-suse-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8BIT Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org On Sun, 5 Jan 2020 23:49:48 +0100, Luca Ceresoli wrote: > - state the "official" name (I²C, not I2C, according to the spec) at > the beginning but keep using the more practical I2C elsewhere > - mention some known different names > - add link to the specification document Indentation is inconsistent. > > Signed-off-by: Luca Ceresoli > --- > Documentation/i2c/summary.rst | 18 ++++++++++++------ > 1 file changed, 12 insertions(+), 6 deletions(-) > > diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst > index 3a24eac17375..b7d3e620155b 100644 > --- a/Documentation/i2c/summary.rst > +++ b/Documentation/i2c/summary.rst > @@ -2,12 +2,18 @@ > I2C and SMBus > ============= > > -I2C (pronounce: I squared C) is a protocol developed by Philips. It is a > -slow two-wire protocol (variable speed, up to 400 kHz), with a high speed > -extension (3.4 MHz). It provides an inexpensive bus for connecting many > -types of devices with infrequent or low bandwidth communications needs. > -I2C is widely used with embedded systems. Some systems use variants that > -don't meet branding requirements, and so are not advertised as being I2C. > +I²C (pronounce: I squared C and written I2C in the kernel documentation) is > +a protocol developed by Philips. It is a slow two-wire protocol (variable > +speed, up to 400 kHz), with a high speed extension (3.4 MHz). It provides > +an inexpensive bus for connecting many types of devices with infrequent or > +low bandwidth communications needs. I2C is widely used with embedded > +systems. Some systems use variants that don't meet branding requirements, > +and so are not advertised as being I2C but with different names, e.g. TWI > +(Two Wire Interface), IIC. Maybe that's just me but "but with different names" sounds strange to me in the sentence construct. Maybe "but come under different names" instead? > + > +The official I2C specification is the `"I2C-bus specification and user > +manual" (UM10204) `_ > +published by NXP Semiconductors. > > SMBus (System Management Bus) is based on the I2C protocol, and is mostly > a subset of I2C protocols and signaling. Many I2C devices will work on an Reviewed-by: Jean Delvare -- Jean Delvare SUSE L3 Support