diff mbox series

[v2,8/9] Documentation: gpio: document gpio-mockup as obsoleted by gpio-sim

Message ID 20240115004847.22369-9-warthog618@gmail.com
State Accepted
Commit c3d336cae79728f8ed6711c5a6179cdc66802e89
Headers show
Series Documentation: gpio: add character device userspace API documentation | expand

Commit Message

Kent Gibson Jan. 15, 2024, 12:48 a.m. UTC 
Update the gpio-mockup documentation to note that is has been
obsoleted by the gpio-sim.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
---
 Documentation/admin-guide/gpio/gpio-mockup.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
diff mbox series

Patch

diff --git a/Documentation/admin-guide/gpio/gpio-mockup.rst b/Documentation/admin-guide/gpio/gpio-mockup.rst
index 493071da1738..d6e7438a7550 100644
--- a/Documentation/admin-guide/gpio/gpio-mockup.rst
+++ b/Documentation/admin-guide/gpio/gpio-mockup.rst
@@ -3,6 +3,14 @@ 
 GPIO Testing Driver
 ===================
 
+.. note::
+
+   This module has been obsoleted by the more flexible gpio-sim.rst.
+   New developments should use that API and existing developments are
+   encouraged to migrate as soon as possible.
+   This module will continue to be maintained but no new features will be
+   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