public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
* [patch] fix typo in i2c smbus documentation
@ 2006-12-28  4:39 Mike Frysinger
  2006-12-30  9:11 ` Jean Delvare
  0 siblings, 1 reply; 2+ messages in thread
From: Mike Frysinger @ 2006-12-28  4:39 UTC (permalink / raw)
  To: khali, Andrew Morton; +Cc: i2c, linux-kernel

[-- Attachment #1: Type: text/plain, Size: 288 bytes --]

the i2c smbus documentation has a typo ... when it describes the
"SMBus Write Word Data" function, it says that it is meant to "read
from a device" when in reality it should obviously be writing to the
device

btw, the i2c/smbus docs in Documentation/i2c/ are superb, thanks all :)
-mike

[-- Attachment #2: linux-i2c-smbus-doc-typo.patch --]
[-- Type: application/octet-stream, Size: 675 bytes --]

Fix typo in SMBus Write Word Data description (write data, dont read it).

Signed-off-by: Mike Frysinger <vapier@gentoo.org>

diff --git a/Documentation/i2c/smbus-protocol b/Documentation/i2c/smbus-protocol
index 09f5e5c..3baedec 100644
--- a/Documentation/i2c/smbus-protocol
+++ b/Documentation/i2c/smbus-protocol
@@ -97,7 +97,7 @@ SMBus Write Word Data
 =====================
 
 This is the opposite operation of the Read Word Data command. 16 bits
-of data is read from a device, from a designated register that is 
+of data is written to a device to the designated register that is 
 specified through the Comm byte. 
 
 S Addr Wr [A] Comm [A] DataLow [A] DataHigh [A] P

^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [patch] fix typo in i2c smbus documentation
  2006-12-28  4:39 [patch] fix typo in i2c smbus documentation Mike Frysinger
@ 2006-12-30  9:11 ` Jean Delvare
  0 siblings, 0 replies; 2+ messages in thread
From: Jean Delvare @ 2006-12-30  9:11 UTC (permalink / raw)
  To: vapier.adi, akpm; +Cc: i2c, linux-kernel


Hi Mike,

On 12/28/2006, Mike Frysinger wrote:
> the i2c smbus documentation has a typo ... when it describes the
> "SMBus Write Word Data" function, it says that it is meant to "read
> from a device" when in reality it should obviously be writing to the
> device

Good catch, applied, thanks. I've also backported this fix to i2c-SVN
and linux-2.4, as they also had the mistake.

> btw, the i2c/smbus docs in Documentation/i2c/ are superb, thanks all :)

You're welcome :)

--
Jean Delvare

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2006-12-30  9:22 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2006-12-28  4:39 [patch] fix typo in i2c smbus documentation Mike Frysinger
2006-12-30  9:11 ` Jean Delvare

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox