[2/2] Documentation: move driver-api/dcdbas to userspace-api/
Commit Message
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%)
Comments
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.
> */
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%)
>
@@ -78,7 +78,6 @@ available subsections can be seen below.
backlight/lp855x-driver.rst
connector
console
- dcdbas
eisa
isa
io-mapping
similarity index 100%
rename from Documentation/driver-api/dcdbas.rst
rename to Documentation/userspace-api/dcdbas.rst
@@ -32,6 +32,7 @@ place where this information is gathered.
futex2
tee
isapnp
+ dcdbas
.. only:: subproject and html
@@ -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
@@ -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.
@@ -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.
*/