i2c: update i2c-dev.h warning in documentation
authorCengiz C <cengizc@gmail.com>
Tue, 12 Dec 2017 16:43:09 +0000 (19:43 +0300)
committerJonathan Corbet <corbet@lwn.net>
Thu, 21 Dec 2017 20:39:30 +0000 (13:39 -0700)
commit91b28aeb17ce13065d745a1f92c95011c10ba75a
tree426ec7d073a1ff2ed0b75ca5b3ae77af8550874f
parent90b2a01e68167665a3f86c477414e795cd4a0139
i2c: update i2c-dev.h warning in documentation

`Documentation/i2c/dev-interface` gives examples for accessing i2c from
userspace.

There's a note that warns developers about the two `i2c-dev.h` header
files which were shipped with the kernel and i2c-tools separately.

However, following i2c-tools commits suggest that the header files are now
identical (in functionality) and `i2c_*` helper functions are now defined
in a separate header called `i2c/smbus.h`, which is distributed with
i2c-tools:

commit 652619121974 ("Minimize differences with kernel flavor")
commit 93caf007f4cb ("Move SMBus helper functions to include/i2c/smbus.h")

Thus, I've converted the warning paragraph into a historical note and
updated the suggested header files.

Signed-off-by: Cengiz Can <cengizc@gmail.com>
Cc: Wolfram Sang <wsa@the-dreams.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/i2c/dev-interface