]> pilppa.com Git - linux-2.6-omap-h63xx.git/commit
i2c: Improve smbus-protocol documentation
authorDavid Brownell <david-b@pacbell.net>
Sun, 11 May 2008 18:37:05 +0000 (20:37 +0200)
committerJean Delvare <khali@hyperion.delvare>
Sun, 11 May 2008 18:37:05 +0000 (20:37 +0200)
commit1a31a88f4f1a14f0b28ec3c5c179b93a10b24a18
tree523f713eb76f7df82eed8d076d244225515eaa30
parentc2fc54fcd340cbee47510aa84c346aab3440ba09
i2c: Improve smbus-protocol documentation

Improve the smbus-protocol documentation file somewhat:

 - Use the names of the SMBus protocol operations (from the 2.0
   specification), not made-up-for-Linux names.

 - Add the name of the call used to execute each operation ... and
   point out that there are mismatches, where functions execute
   different protocol operations than their names specify.

The most confusing examples are that "Read Byte" isn't executed by
i2c_smbus_read_byte(), and that "Write Byte" isn't executed by
i2c_smbus_write_byte().  When coding, that's not as bad as it may
seem; but that case would seem to be worth fixing.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
Signed-off-by: Jean Delvare <khali@linux-fr.org>
Documentation/i2c/smbus-protocol