linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Greg KH <gregkh@suse.de>
To: linux-kernel@vger.kernel.org, lm-sensors@lm-sensors.org
Cc: khali@linux-fr.org
Subject: [PATCH] I2C: Clarify the usage of i2c-dev.h
Date: Mon, 11 Jul 2005 15:02:57 -0700	[thread overview]
Message-ID: <1121119377583@kroah.com> (raw)
In-Reply-To: <11211193771329@kroah.com>

[PATCH] I2C: Clarify the usage of i2c-dev.h

Upon suggestion by Nils Roeder, here is an update to the i2c
documentation to clarify which header files user-space applications
relying on the i2c-dev interface should include.

Signed-off-by: Jean Delvare <khali@linux-fr.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>

---
commit 1d772e2587da3c8b0fb8610fcc1c91fd82f87e52
tree 816702c0b2b1a37f772b8884ce2177b88af4ab73
parent a68e2f4895070f3a449bfe5ae1174b73cc900642
author Jean Delvare <khali@linux-fr.org> Sat, 25 Jun 2005 11:37:40 +0200
committer Greg Kroah-Hartman <gregkh@suse.de> Mon, 11 Jul 2005 14:10:37 -0700

 Documentation/i2c/dev-interface |   11 +++++++----
 1 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/Documentation/i2c/dev-interface b/Documentation/i2c/dev-interface
--- a/Documentation/i2c/dev-interface
+++ b/Documentation/i2c/dev-interface
@@ -14,9 +14,12 @@ C example
 =========
 
 So let's say you want to access an i2c adapter from a C program. The
-first thing to do is `#include <linux/i2c.h>" and "#include <linux/i2c-dev.h>. 
-Yes, I know, you should never include kernel header files, but until glibc 
-knows about i2c, there is not much choice.
+first thing to do is "#include <linux/i2c-dev.h>". Please note that
+there are two files named "i2c-dev.h" out there, one is distributed
+with the Linux kernel and is meant to be included from kernel
+driver code, the other one is distributed with lm_sensors and is
+meant to be included from user-space programs. You obviously want
+the second one here.
 
 Now, you have to decide which adapter you want to access. You should
 inspect /sys/class/i2c-dev/ to decide this. Adapter numbers are assigned
@@ -78,7 +81,7 @@ Full interface description
 ==========================
 
 The following IOCTLs are defined and fully supported 
-(see also i2c-dev.h and i2c.h):
+(see also i2c-dev.h):
 
 ioctl(file,I2C_SLAVE,long addr)
   Change slave address. The address is passed in the 7 lower bits of the


  reply	other threads:[~2005-07-11 22:09 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-07-11 22:01 [GIT PATCH] I2C patches for 2.6.13-rc2 Greg KH
2005-07-11 22:02 ` [PATCH] I2C: max6875 documentation update Greg KH
2005-07-11 22:02   ` [PATCH] I2C: max6875 Kconfig update Greg KH
2005-07-11 22:02     ` [PATCH] I2C: drop bogus eeprom comment Greg KH
2005-07-11 22:02       ` [PATCH] I2C: Strip trailing whitespace from strings Greg KH
2005-07-11 22:02         ` [PATCH] I2C: m41t00: fix incorrect kfree Greg KH
2005-07-11 22:02           ` [PATCH] I2C: Coding style cleanups to via686a Greg KH
2005-07-11 22:02             ` [PATCH] I2C: minor TPS6501x cleanups Greg KH
2005-07-11 22:02               ` [PATCH] I2C: New max6875 driver may corrupt EEPROMs Greg KH
2005-07-11 22:02                 ` [PATCH] i2c: make better use of IDR in i2c-core Greg KH
2005-07-11 22:02                   ` [PATCH] w1: fix CRC calculation on bigendian platforms Greg KH
2005-07-11 22:02                     ` Greg KH [this message]
2005-07-11 22:02                       ` [PATCH] I2C: minor I2C doc cleanups Greg KH
2005-07-11 22:02                         ` [PATCH] I2C: SENSORS_ATXP1 must select I2C_SENSOR Greg KH
2005-07-11 22:02                           ` [PATCH] I2C: Documentation fix Greg KH
2005-07-11 22:02                             ` [PATCH] I2C: Move hwmon drivers (1/3) Greg KH

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1121119377583@kroah.com \
    --to=gregkh@suse.de \
    --cc=greg@kroah.com \
    --cc=khali@linux-fr.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lm-sensors@lm-sensors.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).