linux.git/Documentation/i2c, branch v5.7

i2c: convert SMBus alert setup function to return an ERRPTR

2020-03-10T11:19:52+00:00

Only few drivers use this call, so drivers and I2C core are converted at
once with this patch. By simply using i2c_new_client_device() instead of
i2c_new_device(), we easily can return an ERRPTR for this function as
well. To make out of tree users aware that something changed, the
function is renamed to i2c_new_smbus_alert_device().

Signed-off-by: Wolfram Sang 
Reviewed-by: Luca Ceresoli 
Signed-off-by: Wolfram Sang

docs: i2c: writing-clients: properly name the stop condition

2020-01-29T21:02:09+00:00

In I2C there is no such thing as a "stop bit". Use the proper naming: "stop
condition".

Signed-off-by: Luca Ceresoli 
Reported-by: Jean Delvare 
Reviewed-by: Jean Delvare 
Signed-off-by: Wolfram Sang

docs: i2c: i2c-protocol: use same wording as smbus-protocol

2020-01-29T21:02:07+00:00

In smbus-protocol.rst we use the text "Implemented by" for the same meaning
as "This corresponds to". Change everything to "Implemented by" for
coherency.

Signed-off-by: Luca Ceresoli 
Reported-by: Jean Delvare 
Reviewed-by: Jean Delvare 
Signed-off-by: Wolfram Sang

docs: i2c: rename sections so the overall picture is clearer

2020-01-29T21:02:06+00:00

Some of the section names are not very clear. Reading those names in the
index.rst page does not help much in grasping what the content is supposed
to be.

Rename those sections to clarify their content, especially when reading
the index page.

Signed-off-by: Luca Ceresoli 
Acked-by: Peter Rosin 
Reviewed-by: Jean Delvare 
Signed-off-by: Wolfram Sang

docs: i2c: old-module-parameters: use monospace instead of ""

2020-01-29T21:01:59+00:00

Use a monospace (literal) formatting for better readability of sysfs
attributes and the "dummy" client name. This looks much more readable in
ReST-generated output.

Signed-off-by: Luca Ceresoli 
Reviewed-by: Jean Delvare 
Signed-off-by: Wolfram Sang

docs: i2c: old-module-parameters: clarify this is for obsolete kernels

2020-01-29T21:01:57+00:00

This section applies only to code for very old kernels. Avoid people
reading this unnecessarily.

Signed-off-by: Luca Ceresoli 
Reviewed-by: Jean Delvare 
Signed-off-by: Wolfram Sang

docs: i2c: old-module-parameters: fix internal hyperlink

2020-01-29T21:01:56+00:00

Use ReST syntax so that a proper hyperlink is generated.

Signed-off-by: Luca Ceresoli 
Reviewed-by: Jean Delvare 
Signed-off-by: Wolfram Sang

docs: i2c: instantiating-devices: use monospace for sysfs attributes

2020-01-29T21:01:54+00:00

Use a monospace (literal) formatting for better readability of sysfs
attributes.

Signed-off-by: Luca Ceresoli 
Reviewed-by: Jean Delvare 
Signed-off-by: Wolfram Sang

docs: i2c: instantiating-devices: rearrange static instatiation

2020-01-29T21:01:52+00:00

Among the "static" instantiation methods the "board file" method is
described first. Move it as last, since it is being replaced by the other
methods.

Also fix subsubsection heading syntax and remove the "Method 1[abc]"
prefix as the subsubsection structure clarifies the logical hierarchy.

Signed-off-by: Luca Ceresoli 
Reviewed-by: Jean Delvare 
Signed-off-by: Wolfram Sang

docs: i2c: instantiating-devices: fix internal hyperlink

2020-01-29T21:01:51+00:00

Use ReST syntax so that a proper hyperlink is generated.

Signed-off-by: Luca Ceresoli 
Reviewed-by: Jean Delvare 
Signed-off-by: Wolfram Sang