[PATCH 0/2] Move driver-api/{dcdbas,isapnp} to userspace-api/

[PATCH 0/2] Move driver-api/{dcdbas,isapnp} to userspace-api/

[Vegard Nossum]

Hi,

Neither isapnp.rst nor dcdbas.rst document driver APIs; rather, they
document /proc and /sys interfaces, respectively, which are userspace
APIs.

I'm submitting this to the documentation tree -- Jaroslav and Stuart,
is that OK with you? I suggest doing it that way since there is a tiny
dependency between the patches (for the driver-api/index.rst and
userspace-api/index.rst changes).

Testing: ran htmldocs, didn't see any warnings related to these.

Thanks,


Vegard

--

Vegard Nossum (2):
  Documentation: move driver-api/isapnp to userspace-api/
  Documentation: move driver-api/dcdbas to userspace-api/

 Documentation/driver-api/index.rst                     | 2 --
 Documentation/{driver-api => userspace-api}/dcdbas.rst | 0
 Documentation/userspace-api/index.rst                  | 2 ++
 Documentation/{driver-api => userspace-api}/isapnp.rst | 8 ++++----
 MAINTAINERS                                            | 4 ++--
 drivers/platform/x86/dell/Kconfig                      | 2 +-
 drivers/platform/x86/dell/dcdbas.c                     | 2 +-
 drivers/pnp/isapnp/Kconfig                             | 2 +-
 8 files changed, 11 insertions(+), 11 deletions(-)
 rename Documentation/{driver-api => userspace-api}/dcdbas.rst (100%)
 rename Documentation/{driver-api => userspace-api}/isapnp.rst (51%)

-- 
2.34.1

[PATCH 1/2] Documentation: move driver-api/isapnp to userspace-api/

[Vegard Nossum]

driver-api/isapnp documents /proc interfaces for interfacing directly
with ISA Plug & Play devices, not any kind of API for kernel developers,
and should thus also live under userspace-api/.

Also fix a few issues while we're at it.

Cc: Jaroslav Kysela <perex@perex.cz>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>
Cc: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
---
 Documentation/driver-api/index.rst                     | 1 -
 Documentation/userspace-api/index.rst                  | 1 +
 Documentation/{driver-api => userspace-api}/isapnp.rst | 8 ++++----
 MAINTAINERS                                            | 2 +-
 drivers/pnp/isapnp/Kconfig                             | 2 +-
 5 files changed, 7 insertions(+), 7 deletions(-)
 rename Documentation/{driver-api => userspace-api}/isapnp.rst (51%)

diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 9511db303446..b1b82ac1063b 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -81,7 +81,6 @@ available subsections can be seen below.
    dcdbas
    eisa
    isa
-   isapnp
    io-mapping
    io_ordering
    generic-counter
diff --git a/Documentation/userspace-api/index.rst b/Documentation/userspace-api/index.rst
index 93174ffc7350..277b7a40ca91 100644
--- a/Documentation/userspace-api/index.rst
+++ b/Documentation/userspace-api/index.rst
@@ -31,6 +31,7 @@ place where this information is gathered.
    vduse
    futex2
    tee
+   isapnp
 
 .. only::  subproject and html
 
diff --git a/Documentation/driver-api/isapnp.rst b/Documentation/userspace-api/isapnp.rst
similarity index 51%
rename from Documentation/driver-api/isapnp.rst
rename to Documentation/userspace-api/isapnp.rst
index 8d0840ac847b..d6fceb19b8ae 100644
--- a/Documentation/driver-api/isapnp.rst
+++ b/Documentation/userspace-api/isapnp.rst
@@ -1,11 +1,11 @@
-==========================================================
-ISA Plug & Play support by Jaroslav Kysela <perex@suse.cz>
-==========================================================
+=======================
+ISA Plug & Play support
+=======================
 
 Interface /proc/isapnp
 ======================
 
-The interface has been removed. See pnp.txt for more details.
+The interface was removed in kernel 2.5.53. See pnp.rst for more details.
 
 Interface /proc/bus/isapnp
 ==========================
diff --git a/MAINTAINERS b/MAINTAINERS
index 0506d14340f7..7b6d2dbe4f1d 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -11252,7 +11252,7 @@ F:	drivers/media/radio/radio-isa*
 ISAPNP
 M:	Jaroslav Kysela <perex@perex.cz>
 S:	Maintained
-F:	Documentation/driver-api/isapnp.rst
+F:	Documentation/userspace-api/isapnp.rst
 F:	drivers/pnp/isapnp/
 F:	include/linux/isapnp.h
 
diff --git a/drivers/pnp/isapnp/Kconfig b/drivers/pnp/isapnp/Kconfig
index d0479a563123..8b5f2e461a80 100644
--- a/drivers/pnp/isapnp/Kconfig
+++ b/drivers/pnp/isapnp/Kconfig
@@ -7,6 +7,6 @@ config ISAPNP
 	depends on ISA || COMPILE_TEST
 	help
 	  Say Y here if you would like support for ISA Plug and Play devices.
-	  Some information is in <file:Documentation/driver-api/isapnp.rst>.
+	  Some information is in <file:Documentation/userspace-api/isapnp.rst>.
 
 	  If unsure, say Y.
-- 
2.34.1

[PATCH 2/2] Documentation: move driver-api/dcdbas to userspace-api/

[Vegard Nossum]

This file documents a sysfs interface that is intended for systems
management software. It does NOT document any kind of kernel driver
API. It is also not meant to be used directly by system administrators
or users.

Cc: Stuart Hayes <stuart.w.hayes@gmail.com>
Cc: platform-driver-x86@vger.kernel.org
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
---
 Documentation/driver-api/index.rst                     | 1 -
 Documentation/{driver-api => userspace-api}/dcdbas.rst | 0
 Documentation/userspace-api/index.rst                  | 1 +
 MAINTAINERS                                            | 2 +-
 drivers/platform/x86/dell/Kconfig                      | 2 +-
 drivers/platform/x86/dell/dcdbas.c                     | 2 +-
 6 files changed, 4 insertions(+), 4 deletions(-)
 rename Documentation/{driver-api => userspace-api}/dcdbas.rst (100%)

diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index b1b82ac1063b..b38f81836118 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -78,7 +78,6 @@ available subsections can be seen below.
    backlight/lp855x-driver.rst
    connector
    console
-   dcdbas
    eisa
    isa
    io-mapping
diff --git a/Documentation/driver-api/dcdbas.rst b/Documentation/userspace-api/dcdbas.rst
similarity index 100%
rename from Documentation/driver-api/dcdbas.rst
rename to Documentation/userspace-api/dcdbas.rst
diff --git a/Documentation/userspace-api/index.rst b/Documentation/userspace-api/index.rst
index 277b7a40ca91..74bc0716432e 100644
--- a/Documentation/userspace-api/index.rst
+++ b/Documentation/userspace-api/index.rst
@@ -32,6 +32,7 @@ place where this information is gathered.
    futex2
    tee
    isapnp
+   dcdbas
 
 .. only::  subproject and html
 
diff --git a/MAINTAINERS b/MAINTAINERS
index 7b6d2dbe4f1d..aa9c4c7ebe71 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -5901,7 +5901,7 @@ DELL SYSTEMS MANAGEMENT BASE DRIVER (dcdbas)
 M:	Stuart Hayes <stuart.w.hayes@gmail.com>
 L:	platform-driver-x86@vger.kernel.org
 S:	Maintained
-F:	Documentation/driver-api/dcdbas.rst
+F:	Documentation/userspace-api/dcdbas.rst
 F:	drivers/platform/x86/dell/dcdbas.*
 
 DELL WMI DDV DRIVER
diff --git a/drivers/platform/x86/dell/Kconfig b/drivers/platform/x86/dell/Kconfig
index bdd78076b1d7..e712df67fa6b 100644
--- a/drivers/platform/x86/dell/Kconfig
+++ b/drivers/platform/x86/dell/Kconfig
@@ -37,7 +37,7 @@ config DCDBAS
 	  Interrupts (SMIs) and Host Control Actions (system power cycle or
 	  power off after OS shutdown) on certain Dell systems.
 
-	  See <file:Documentation/driver-api/dcdbas.rst> for more details on the driver
+	  See <file:Documentation/userspace-api/dcdbas.rst> for more details on the driver
 	  and the Dell systems on which Dell systems management software makes
 	  use of this driver.
 
diff --git a/drivers/platform/x86/dell/dcdbas.c b/drivers/platform/x86/dell/dcdbas.c
index 76787369d7fa..a60e35056387 100644
--- a/drivers/platform/x86/dell/dcdbas.c
+++ b/drivers/platform/x86/dell/dcdbas.c
@@ -7,7 +7,7 @@
  *  and Host Control Actions (power cycle or power off after OS shutdown) on
  *  Dell systems.
  *
- *  See Documentation/driver-api/dcdbas.rst for more information.
+ *  See Documentation/userspace-api/dcdbas.rst for more information.
  *
  *  Copyright (C) 1995-2006 Dell Inc.
  */
-- 
2.34.1

Re: [PATCH 2/2] Documentation: move driver-api/dcdbas to userspace-api/

[Hans de Goede]

Hi,

On 12/21/23 13:48, Vegard Nossum wrote:
> This file documents a sysfs interface that is intended for systems
> management software. It does NOT document any kind of kernel driver
> API. It is also not meant to be used directly by system administrators
> or users.
> 
> Cc: Stuart Hayes <stuart.w.hayes@gmail.com>
> Cc: platform-driver-x86@vger.kernel.org
> Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>

Thanks, patch looks good to me. Here is my ack
for merging the drivers/platform/x86/dell/ bits through
the Documentation tree:

Acked-by: Hans de Goede <hdegoede@redhat.com>

Regards,

Hans





> ---
>  Documentation/driver-api/index.rst                     | 1 -
>  Documentation/{driver-api => userspace-api}/dcdbas.rst | 0
>  Documentation/userspace-api/index.rst                  | 1 +
>  MAINTAINERS                                            | 2 +-
>  drivers/platform/x86/dell/Kconfig                      | 2 +-
>  drivers/platform/x86/dell/dcdbas.c                     | 2 +-
>  6 files changed, 4 insertions(+), 4 deletions(-)
>  rename Documentation/{driver-api => userspace-api}/dcdbas.rst (100%)
> 
> diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
> index b1b82ac1063b..b38f81836118 100644
> --- a/Documentation/driver-api/index.rst
> +++ b/Documentation/driver-api/index.rst
> @@ -78,7 +78,6 @@ available subsections can be seen below.
>     backlight/lp855x-driver.rst
>     connector
>     console
> -   dcdbas
>     eisa
>     isa
>     io-mapping
> diff --git a/Documentation/driver-api/dcdbas.rst b/Documentation/userspace-api/dcdbas.rst
> similarity index 100%
> rename from Documentation/driver-api/dcdbas.rst
> rename to Documentation/userspace-api/dcdbas.rst
> diff --git a/Documentation/userspace-api/index.rst b/Documentation/userspace-api/index.rst
> index 277b7a40ca91..74bc0716432e 100644
> --- a/Documentation/userspace-api/index.rst
> +++ b/Documentation/userspace-api/index.rst
> @@ -32,6 +32,7 @@ place where this information is gathered.
>     futex2
>     tee
>     isapnp
> +   dcdbas
>  
>  .. only::  subproject and html
>  
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 7b6d2dbe4f1d..aa9c4c7ebe71 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -5901,7 +5901,7 @@ DELL SYSTEMS MANAGEMENT BASE DRIVER (dcdbas)
>  M:	Stuart Hayes <stuart.w.hayes@gmail.com>
>  L:	platform-driver-x86@vger.kernel.org
>  S:	Maintained
> -F:	Documentation/driver-api/dcdbas.rst
> +F:	Documentation/userspace-api/dcdbas.rst
>  F:	drivers/platform/x86/dell/dcdbas.*
>  
>  DELL WMI DDV DRIVER
> diff --git a/drivers/platform/x86/dell/Kconfig b/drivers/platform/x86/dell/Kconfig
> index bdd78076b1d7..e712df67fa6b 100644
> --- a/drivers/platform/x86/dell/Kconfig
> +++ b/drivers/platform/x86/dell/Kconfig
> @@ -37,7 +37,7 @@ config DCDBAS
>  	  Interrupts (SMIs) and Host Control Actions (system power cycle or
>  	  power off after OS shutdown) on certain Dell systems.
>  
> -	  See <file:Documentation/driver-api/dcdbas.rst> for more details on the driver
> +	  See <file:Documentation/userspace-api/dcdbas.rst> for more details on the driver
>  	  and the Dell systems on which Dell systems management software makes
>  	  use of this driver.
>  
> diff --git a/drivers/platform/x86/dell/dcdbas.c b/drivers/platform/x86/dell/dcdbas.c
> index 76787369d7fa..a60e35056387 100644
> --- a/drivers/platform/x86/dell/dcdbas.c
> +++ b/drivers/platform/x86/dell/dcdbas.c
> @@ -7,7 +7,7 @@
>   *  and Host Control Actions (power cycle or power off after OS shutdown) on
>   *  Dell systems.
>   *
> - *  See Documentation/driver-api/dcdbas.rst for more information.
> + *  See Documentation/userspace-api/dcdbas.rst for more information.
>   *
>   *  Copyright (C) 1995-2006 Dell Inc.
>   */

Re: [PATCH 2/2] Documentation: move driver-api/dcdbas to userspace-api/

[Randy Dunlap]

On 12/21/23 04:48, Vegard Nossum wrote:
> This file documents a sysfs interface that is intended for systems
> management software. It does NOT document any kind of kernel driver
> API. It is also not meant to be used directly by system administrators
> or users.
> 
> Cc: Stuart Hayes <stuart.w.hayes@gmail.com>
> Cc: platform-driver-x86@vger.kernel.org
> Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.

> ---
>  Documentation/driver-api/index.rst                     | 1 -
>  Documentation/{driver-api => userspace-api}/dcdbas.rst | 0
>  Documentation/userspace-api/index.rst                  | 1 +
>  MAINTAINERS                                            | 2 +-
>  drivers/platform/x86/dell/Kconfig                      | 2 +-
>  drivers/platform/x86/dell/dcdbas.c                     | 2 +-
>  6 files changed, 4 insertions(+), 4 deletions(-)
>  rename Documentation/{driver-api => userspace-api}/dcdbas.rst (100%)
> 

-- 
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html

Re: [PATCH 1/2] Documentation: move driver-api/isapnp to userspace-api/

[Randy Dunlap]

On 12/21/23 04:48, Vegard Nossum wrote:
> driver-api/isapnp documents /proc interfaces for interfacing directly
> with ISA Plug & Play devices, not any kind of API for kernel developers,
> and should thus also live under userspace-api/.
> 
> Also fix a few issues while we're at it.
> 
> Cc: Jaroslav Kysela <perex@perex.cz>
> Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
> Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>
> Cc: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>
> Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.

> ---
>  Documentation/driver-api/index.rst                     | 1 -
>  Documentation/userspace-api/index.rst                  | 1 +
>  Documentation/{driver-api => userspace-api}/isapnp.rst | 8 ++++----
>  MAINTAINERS                                            | 2 +-
>  drivers/pnp/isapnp/Kconfig                             | 2 +-
>  5 files changed, 7 insertions(+), 7 deletions(-)
>  rename Documentation/{driver-api => userspace-api}/isapnp.rst (51%)
> 

-- 
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html

Re: [PATCH 0/2] Move driver-api/{dcdbas,isapnp} to userspace-api/

[Jonathan Corbet]

Vegard Nossum <vegard.nossum@oracle.com> writes:

> Hi,
>
> Neither isapnp.rst nor dcdbas.rst document driver APIs; rather, they
> document /proc and /sys interfaces, respectively, which are userspace
> APIs.
>
> I'm submitting this to the documentation tree -- Jaroslav and Stuart,
> is that OK with you? I suggest doing it that way since there is a tiny
> dependency between the patches (for the driver-api/index.rst and
> userspace-api/index.rst changes).
>
> Testing: ran htmldocs, didn't see any warnings related to these.

Applied, thanks.

jon