diff mbox series

[v2] i2c: Update documentation to use .probe() again

Message ID 20230627064522.593332-1-u.kleine-koenig@pengutronix.de
State Accepted
Headers show
Series [v2] i2c: Update documentation to use .probe() again | expand

Commit Message

Uwe Kleine-König June 27, 2023, 6:45 a.m. UTC
Since commit 03c835f498b5 ("i2c: Switch .probe() to not take an id
parameter") .probe() is the recommended callback to implement (again).
Reflect this in the documentation and don't mention .probe_new() any
more.

Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
---
Hello,

changes since (implicit) v1 sent a moment ago:

 - Fix whitespace. My editor seems to be configured to expand tabs to
   spaces in rst files, but that's inconsitent with the tab style used
   in that file.

Best regards
Uwe

 Documentation/i2c/writing-clients.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


base-commit: 6995e2de6891c724bfeb2db33d7b87775f913ad1

Comments

Jean Delvare June 27, 2023, 11:44 a.m. UTC | #1
On Tue, 27 Jun 2023 08:45:22 +0200, Uwe Kleine-König wrote:
> Since commit 03c835f498b5 ("i2c: Switch .probe() to not take an id
> parameter") .probe() is the recommended callback to implement (again).
> Reflect this in the documentation and don't mention .probe_new() any
> more.
> 
> Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
> ---
> Hello,
> 
> changes since (implicit) v1 sent a moment ago:
> 
>  - Fix whitespace. My editor seems to be configured to expand tabs to
>    spaces in rst files, but that's inconsitent with the tab style used
>    in that file.
> 
> Best regards
> Uwe
> 
>  Documentation/i2c/writing-clients.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/i2c/writing-clients.rst b/Documentation/i2c/writing-clients.rst
> index b7d3ae7458f8..41ddc10f1ac7 100644
> --- a/Documentation/i2c/writing-clients.rst
> +++ b/Documentation/i2c/writing-clients.rst
> @@ -46,7 +46,7 @@ driver model device node, and its I2C address.
>  	},
>  
>  	.id_table	= foo_idtable,
> -	.probe_new	= foo_probe,
> +	.probe		= foo_probe,
>  	.remove		= foo_remove,
>  	/* if device autodetection is needed: */
>  	.class		= I2C_CLASS_SOMETHING,
> 
> base-commit: 6995e2de6891c724bfeb2db33d7b87775f913ad1

Reviewed-by: Jean Delvare <jdelvare@suse.de>
Javier Martinez Canillas June 27, 2023, 12:16 p.m. UTC | #2
Uwe Kleine-König <u.kleine-koenig@pengutronix.de> writes:

Hello Uwe,

> Since commit 03c835f498b5 ("i2c: Switch .probe() to not take an id
> parameter") .probe() is the recommended callback to implement (again).
> Reflect this in the documentation and don't mention .probe_new() any
> more.
>
> Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
> ---

Reviewed-by: Javier Martinez Canillas <javierm@redhat.com>
Andi Shyti Aug. 5, 2023, 4:54 p.m. UTC | #3
Hi Uwe,

On Tue, Jun 27, 2023 at 08:45:22AM +0200, Uwe Kleine-König wrote:
> Since commit 03c835f498b5 ("i2c: Switch .probe() to not take an id
> parameter") .probe() is the recommended callback to implement (again).
> Reflect this in the documentation and don't mention .probe_new() any
> more.
> 
> Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>

Reviewed-by: Andi Shyti <andi.shyti@kernel.org> 

Andi
Wolfram Sang Aug. 14, 2023, 4:15 p.m. UTC | #4
On Tue, Jun 27, 2023 at 08:45:22AM +0200, Uwe Kleine-König wrote:
> Since commit 03c835f498b5 ("i2c: Switch .probe() to not take an id
> parameter") .probe() is the recommended callback to implement (again).
> Reflect this in the documentation and don't mention .probe_new() any
> more.
> 
> Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>

Applied to for-current, thanks!
diff mbox series

Patch

diff --git a/Documentation/i2c/writing-clients.rst b/Documentation/i2c/writing-clients.rst
index b7d3ae7458f8..41ddc10f1ac7 100644
--- a/Documentation/i2c/writing-clients.rst
+++ b/Documentation/i2c/writing-clients.rst
@@ -46,7 +46,7 @@  driver model device node, and its I2C address.
 	},
 
 	.id_table	= foo_idtable,
-	.probe_new	= foo_probe,
+	.probe		= foo_probe,
 	.remove		= foo_remove,
 	/* if device autodetection is needed: */
 	.class		= I2C_CLASS_SOMETHING,