Documentation/i2c: direct users to i2c-tools regarding i2c/smbus.h
Subsystems (3)
PATCH 1/1 Documentation/i2c: direct users to i2c-tools regarding i2c/smbus.h
The current examples reference i2c/smbus.h, which is the first reference in Documentation/i2c/dev-interface to anything related to the i2c-tools project. This moves the existing reference to i2c-tools up into the C-example, directing the user to the project's git repository.
--- Documentation/i2c/dev-interface | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/i2c/dev-interface +4 -4
@@ -23,6 +23,10 @@ First, you need to include these two headers: #include <linux/i2c-dev.h> #include <i2c/smbus.h> +The i2c/smbus header file is provided by the i2c-tools project. For more info +about i2c-tools, see: +https://git.kernel.org/pub/scm/utils/i2c-tools/i2c-tools.git/ + Now, you have to decide which adapter you want to access. You should inspect /sys/class/i2c-dev/ or run "i2cdetect -l" to decide this. Adapter numbers are assigned somewhat dynamically, so you can not
@@ -163,10 +167,6 @@ what happened. The 'write' transactions return 0 on success; the returns the number of values read. The block buffers need not be longer than 32 bytes. -The above functions are made available by linking against the libi2c library, -which is provided by the i2c-tools project. See: -https://git.kernel.org/pub/scm/utils/i2c-tools/i2c-tools.git/. - Implementation details ======================
Signature · 1 line
2.17.0.484.g0c8726318c-goog
friendly ping :)
This was an incremental patch requested by Wolfram.
Quoted 39 lines · Sam Hansen
The current examples reference
i2c/smbus.h, which is the first reference inDocumentation/i2c/dev-interfaceto anything related to the i2c-tools project. This moves the existing reference to i2c-tools up into the C-example, directing the user to the project's git repository.Signed-off-by Sam Hansen <[email protected]>--- Documentation/i2c/dev-interface | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)Documentation/i2c/dev-interface +4
-5@@ -23,6 +23,10 @@ First, you need to include these two headers: #include <linux/i2c-dev.h> #include <i2c/smbus.h> +The i2c/smbus header file is provided by the i2c-tools project. For more info +about i2c-tools, see: +https://git.kernel.org/pub/scm/utils/i2c-tools/i2c-tools.git/ + Now, you have to decide which adapter you want to access. You should inspect /sys/class/i2c-dev/ or run "i2cdetect -l" to decide this. Adapter numbers are assigned somewhat dynamically, so you can not@@ -163,10 +167,6 @@ what happened. The 'write' transactions return 0 on success; the returns the number of values read. The block buffers need not be longer than 32 bytes. -The above functions are made available by linking against the libi2c library, -which is provided by the i2c-tools project. See: -https://git.kernel.org/pub/scm/utils/i2c-tools/i2c-tools.git/. - Implementation details ====================== --2.17.0.484.g0c8726318c-goog
Hi Sam,
Please don't include the same persons in To: and Cc:. It makes the message delivered twice to them.
Quoted 26 lines · Sam Hansen
The current examples reference
i2c/smbus.h, which is the first reference inDocumentation/i2c/dev-interfaceto anything related to the i2c-tools project. This moves the existing reference to i2c-tools up into the C-example, directing the user to the project's git repository.Signed-off-by Sam Hansen <[email protected]>--- Documentation/i2c/dev-interface | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)Documentation/i2c/dev-interface +4
-0@@ -23,6 +23,10 @@ First, you need to include these two headers: #include <linux/i2c-dev.h> #include <i2c/smbus.h> +The i2c/smbus header file is provided by the i2c-tools project. For more info +about i2c-tools, see: +https://git.kernel.org/pub/scm/utils/i2c-tools/i2c-tools.git/ + Now, you have to decide which adapter you want to access. You should inspect /sys/class/i2c-dev/ or run "i2cdetect -l" to decide this. Adapter numbers are assigned somewhat dynamically, so you can not
Documentation/i2c/dev-interface what happened. The 'write' transactions return 0 on success; the · line 169
Quoted 7 lines
Documentation/i2c/dev-interface +0
-4@@ -163,10 +167,6 @@ what happened. The 'write' transactions return 0 on success; the returns the number of values read. The block buffers need not be longer than 32 bytes. -The above functions are made available by linking against the libi2c library, -which is provided by the i2c-tools project. See: -https://git.kernel.org/pub/scm/utils/i2c-tools/i2c-tools.git/. -
I'm fine with moving the pointer to i2c-tools up in the document. However I find it unfortunate to remove the only reference to libi2c. Typically, distributions will only include the tools in i2c-tools, and they are not relevant in this case. The library will be in a separate package (libi2c or similar), and the header file in yet another package (libi2c-devel or similar.) Although the exact package names are distribution specific, it would be convenient to hint the reader at which packages he is supposed to install. You could also mention that the C program must be compiled with -li2c.
Quoted 3 lines
Documentation/i2c/dev-interface +0
-0Implementation details ======================
Signature · 2 lines
Jean Delvare SUSE L3 Support