diff mbox series

[v2,9/9] Documentation: gpio: move gpio-mockup into obsolete section

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

Commit Message

Kent Gibson Jan. 15, 2024, 12:48 a.m. UTC
The gpio-mockup has been obsoleted by the gpio-sim, so relocate its
documentation into the obsolete section of the admin-guide book.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
---
 Documentation/admin-guide/gpio/index.rst    | 1 -
 Documentation/admin-guide/gpio/obsolete.rst | 1 +
 2 files changed, 1 insertion(+), 1 deletion(-)

Comments

Andy Shevchenko Jan. 15, 2024, 1:20 a.m. UTC | #1
On Mon, Jan 15, 2024 at 2:50 AM Kent Gibson <warthog618@gmail.com> wrote:
>
> The gpio-mockup has been obsoleted by the gpio-sim, so relocate its
> documentation into the obsolete section of the admin-guide book.

...

>      Character Device Userspace API (v1) <../../userspace-api/gpio/chardev_v1>
>      Sysfs Interface <../../userspace-api/gpio/sysfs>
> +    Mockup Testing Module <gpio-mockup>

Not because of the alphabetical ordering, but
historically/semantically shouldn't this be in between?
(I'm fine with either way, just asking)
Kent Gibson Jan. 15, 2024, 1:36 a.m. UTC | #2
On Mon, Jan 15, 2024 at 03:20:08AM +0200, Andy Shevchenko wrote:
> On Mon, Jan 15, 2024 at 2:50 AM Kent Gibson <warthog618@gmail.com> wrote:
> >
> > The gpio-mockup has been obsoleted by the gpio-sim, so relocate its
> > documentation into the obsolete section of the admin-guide book.
>
> ...
>
> >      Character Device Userspace API (v1) <../../userspace-api/gpio/chardev_v1>
> >      Sysfs Interface <../../userspace-api/gpio/sysfs>
> > +    Mockup Testing Module <gpio-mockup>
>
> Not because of the alphabetical ordering, but
> historically/semantically shouldn't this be in between?
> (I'm fine with either way, just asking)
>

It is in order of most interest to the reader, hopefully.
The first two are arguable, but the mockup is clearly last there.
sysfs may actually be of more interest on average, but anyone still
hanging on to sysfs deserves what they get.
If the list were longer I would switch to alphabetical.

Cheers,
Kent.
diff mbox series

Patch

diff --git a/Documentation/admin-guide/gpio/index.rst b/Documentation/admin-guide/gpio/index.rst
index 3f6d5a76702b..460afd29617e 100644
--- a/Documentation/admin-guide/gpio/index.rst
+++ b/Documentation/admin-guide/gpio/index.rst
@@ -9,7 +9,6 @@  GPIO
 
     Character Device Userspace API <../../userspace-api/gpio/chardev>
     gpio-aggregator
-    gpio-mockup
     gpio-sim
     Obsolete APIs <obsolete>
 
diff --git a/Documentation/admin-guide/gpio/obsolete.rst b/Documentation/admin-guide/gpio/obsolete.rst
index 5926e5440207..5adbff02d61f 100644
--- a/Documentation/admin-guide/gpio/obsolete.rst
+++ b/Documentation/admin-guide/gpio/obsolete.rst
@@ -9,4 +9,5 @@  Obsolete GPIO APIs
 
     Character Device Userspace API (v1) <../../userspace-api/gpio/chardev_v1>
     Sysfs Interface <../../userspace-api/gpio/sysfs>
+    Mockup Testing Module <gpio-mockup>