From patchwork Mon Jun 10 08:10:16 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Wolfram Sang X-Patchwork-Id: 803088 Received: from mail.zeus03.de (www.zeus03.de [194.117.254.33]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 79107210E7 for ; Mon, 10 Jun 2024 08:10:33 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=194.117.254.33 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718007039; cv=none; b=SMQ1hjq0FkQOG8CrVj9EZTzNHqNdN5FC5D9FCppkOnKO1/PYEJH3NO1e87OIKnG5aJTHmGdUqwvMoPrioL5/VAq+5GZytRwOUopQz+V468dKBxGZ0tDmqUrH5j7Q96DrtpSN0SadD7moNDV7q8XtclUmVHZiHFsz6OkqcYUOIwU= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718007039; c=relaxed/simple; bh=AaeKWFy6+MhJUSVDuiArePmxqwjpDms46lje4lfg78Y=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=XL5rxRM9DG2xe4LinpjzXv9c0eXaylnuYRuKVoNrBp688+jlHUTTyJusp0bCmwsWEvmzmo9+m5eOdRxnFogiAng6dNYDGsHhEDIbqGutttbOzw2Fa4rUzSPG28It7YkCVudYbgD4KUVIwM8pCB6L3W46JG8xsQgxSD+21qpGpYE= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com; spf=pass smtp.mailfrom=sang-engineering.com; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b=YroE6mVk; arc=none smtp.client-ip=194.117.254.33 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b="YroE6mVk" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= sang-engineering.com; h=from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-type :content-transfer-encoding; s=k1; bh=QxN9/peWzKBlFqRmDXEKD0iHTiZ lunJFWOblMthWaXk=; b=YroE6mVkcVqWLUGY8X1irPIdprRlZDn5mCvhCUJAbqL tCJFMlAb2NJEtMdR1SqZnpfMFJXlGm7GFfC9IfLtpEW9bdhxOYSp7K7hEjGzyo+a IYyMLPWoK62hpXma+lIVmCT03UzefcMUT2Vd7tVCjCBbaBWJX2Gk3M45ONZL1R6F DOzktZcEvT4Iq20Oi7CvP8POLSU4TCdDNLBzkt5rF9TWz3PbMfg1q388YgfZNV0k 8uuEjorBKKTu2jIvGdfw49JyqMXgekVSaIOf+ptd8bf4l3dowCgzuVbSYZSOZTWv smf9YarMkyV7kIhZVM2qVMVld78y2p8qXicvZr9NBsg== Received: (qmail 4192401 invoked from network); 10 Jun 2024 10:10:26 +0200 Received: by mail.zeus03.de with ESMTPSA (TLS_AES_256_GCM_SHA384 encrypted, authenticated); 10 Jun 2024 10:10:26 +0200 X-UD-Smtp-Session: l3s3148p1@tHeCroQavuYgAwDPXymAAHMyzy0c7Kdl From: Wolfram Sang To: linux-i2c@vger.kernel.org Cc: Easwar Hariharan , Andi Shyti , linux-doc@vger.kernel.org, Wolfram Sang , linux-kernel@vger.kernel.org Subject: [PATCH v2 1/6] docs: i2c: summary: start sentences consistently. Date: Mon, 10 Jun 2024 10:10:16 +0200 Message-ID: <20240610081023.8118-2-wsa+renesas@sang-engineering.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240610081023.8118-1-wsa+renesas@sang-engineering.com> References: <20240610081023.8118-1-wsa+renesas@sang-engineering.com> Precedence: bulk X-Mailing-List: linux-i2c@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Change the first paragraphs to contain only one space after the end of the previous sentence like in the rest of the document. Signed-off-by: Wolfram Sang Reviewed-by: Easwar Hariharan --- Documentation/i2c/summary.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/i2c/summary.rst b/Documentation/i2c/summary.rst index 786c618ba3be..28ff80a2302b 100644 --- a/Documentation/i2c/summary.rst +++ b/Documentation/i2c/summary.rst @@ -4,10 +4,10 @@ Introduction to I2C and SMBus 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 +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, +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 come under different names, e.g. TWI (Two Wire Interface), IIC. @@ -18,14 +18,14 @@ access the PDF. An older version of the specification (revision 6) is archived `here `_. 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 +a subset of I2C protocols and signaling. Many I2C devices will work on an SMBus, but some SMBus protocols add semantics beyond what is required to -achieve I2C branding. Modern PC mainboards rely on SMBus. The most common +achieve I2C branding. Modern PC mainboards rely on SMBus. The most common devices connected through SMBus are RAM modules configured using I2C EEPROMs, and hardware monitoring chips. Because the SMBus is mostly a subset of the generalized I2C bus, we can -use its protocols on many I2C systems. However, there are systems that don't +use its protocols on many I2C systems. However, there are systems that don't meet both SMBus and I2C electrical constraints; and others which can't implement all the common SMBus protocol semantics or messages.