diff mbox series

Documentation: gpio: Add a note on the deprecated GPIO Testing Driver

Message ID 20240213160522.37940-1-lincoln.wallace@canonical.com
State New
Headers
Series Documentation: gpio: Add a note on the deprecated GPIO Testing Driver |

Commit Message

lincoln.wallace@canonical.com Feb. 13, 2024, 4:05 p.m. UTC 
  From: Lincoln Wallace <lincoln.wallace@canonical.com>

A deprecation note was added on gpio-mockup Kconfig since v6.7,
update the documentation to inform users.

Signed-off-by: Lincoln Wallace <lincoln.wallace@canonical.com>
---
 Documentation/admin-guide/gpio/gpio-mockup.rst | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Bartosz Golaszewski Feb. 20, 2024, 11:42 a.m. UTC | #1 
On Tue, Feb 13, 2024 at 5:05 PM <lincoln.wallace@canonical.com> wrote:
>
> From: Lincoln Wallace <lincoln.wallace@canonical.com>
>
> A deprecation note was added on gpio-mockup Kconfig since v6.7,
> update the documentation to inform users.
>
> Signed-off-by: Lincoln Wallace <lincoln.wallace@canonical.com>
> ---
>  Documentation/admin-guide/gpio/gpio-mockup.rst | 5 +++++
>  1 file changed, 5 insertions(+)
>
> diff --git a/Documentation/admin-guide/gpio/gpio-mockup.rst b/Documentation/admin-guide/gpio/gpio-mockup.rst
> index 493071da1738..a6424de925da 100644
> --- a/Documentation/admin-guide/gpio/gpio-mockup.rst
> +++ b/Documentation/admin-guide/gpio/gpio-mockup.rst
> @@ -3,6 +3,11 @@
>  GPIO Testing Driver
>  ===================
>
> +.. note::
> +    Since kernel version 6.7, this method is being deprecated. Prefer using
> +    Documentation/admin-guide/gpio/gpio-sim.rst instead for kernel versions
> +    newer than 5.17, which is when gpio-sim was added.
> +
>  The GPIO Testing Driver (gpio-mockup) provides a way to create simulated GPIO
>  chips for testing purposes. The lines exposed by these chips can be accessed
>  using the standard GPIO character device interface as well as manipulated
> --
> 2.40.1
>

We already have a note on that, thanks.

Bart
diff mbox series

Patch

diff --git a/Documentation/admin-guide/gpio/gpio-mockup.rst b/Documentation/admin-guide/gpio/gpio-mockup.rst
index 493071da1738..a6424de925da 100644
--- a/Documentation/admin-guide/gpio/gpio-mockup.rst
+++ b/Documentation/admin-guide/gpio/gpio-mockup.rst
@@ -3,6 +3,11 @@ 
 GPIO Testing Driver
 ===================
 
+.. note::
+    Since kernel version 6.7, this method is being deprecated. Prefer using
+    Documentation/admin-guide/gpio/gpio-sim.rst instead for kernel versions
+    newer than 5.17, which is when gpio-sim was added.
+
 The GPIO Testing Driver (gpio-mockup) provides a way to create simulated GPIO
 chips for testing purposes. The lines exposed by these chips can be accessed
 using the standard GPIO character device interface as well as manipulated