Re: [PATCH] Documentation/i2c: direct users to i2c-tools regarding i2c/smbus.h

From: Sam Hansen
Date: Tue Apr 24 2018 - 20:00:49 EST


friendly ping :)

This was an incremental patch requested by Wolfram.

On Thu, Apr 19, 2018 at 3:23 PM, Sam Hansen <hansens@xxxxxxxxxx> wrote:
> 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.
>
> Signed-off-by: Sam Hansen <hansens@xxxxxxxxxx>
> ---
> Documentation/i2c/dev-interface | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/i2c/dev-interface b/Documentation/i2c/dev-interface
> index fbed645ccd75..ed20f7b7851a 100644
> --- a/Documentation/i2c/dev-interface
> +++ b/Documentation/i2c/dev-interface
> @@ -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
>