diff mbox series

[RFC,v2,19/20] fwctl: Move fwctl documentation to its own directory

Message ID 20241115212745.869552-20-dave.jiang@intel.com
State New
Headers show
Series fwctl/cxl: Add CXL feature commands support via fwctl | expand

Commit Message

Dave Jiang Nov. 15, 2024, 9:25 p.m. UTC
Move fwctl.rst to its own directory in prepraration for adding more
documentation.

Signed-off-by: Dave Jiang <dave.jiang@intel.com>
---
 Documentation/userspace-api/{ => fwctl}/fwctl.rst |  0
 Documentation/userspace-api/fwctl/index.rst       | 12 ++++++++++++
 Documentation/userspace-api/index.rst             |  2 +-
 MAINTAINERS                                       |  2 +-
 4 files changed, 14 insertions(+), 2 deletions(-)
 rename Documentation/userspace-api/{ => fwctl}/fwctl.rst (100%)
 create mode 100644 Documentation/userspace-api/fwctl/index.rst

Comments

Jason Gunthorpe Nov. 20, 2024, 5:52 p.m. UTC | #1
On Fri, Nov 15, 2024 at 02:25:52PM -0700, Dave Jiang wrote:
> Move fwctl.rst to its own directory in prepraration for adding more
> documentation.
> 
> Signed-off-by: Dave Jiang <dave.jiang@intel.com>

I folded this into my tree

Thanks,
Jason
diff mbox series

Patch

diff --git a/Documentation/userspace-api/fwctl.rst b/Documentation/userspace-api/fwctl/fwctl.rst
similarity index 100%
rename from Documentation/userspace-api/fwctl.rst
rename to Documentation/userspace-api/fwctl/fwctl.rst
diff --git a/Documentation/userspace-api/fwctl/index.rst b/Documentation/userspace-api/fwctl/index.rst
new file mode 100644
index 000000000000..06959fbf1547
--- /dev/null
+++ b/Documentation/userspace-api/fwctl/index.rst
@@ -0,0 +1,12 @@ 
+.. SPDX-License-Identifier: GPL-2.0
+
+Firmware Control (FWCTL) Userspace API
+======================================
+
+A framework that define a common set of limited rules that allows user space
+to securely construct and execute RPCs inside device firmware.
+
+.. toctree::
+   :maxdepth: 1
+
+   fwctl
diff --git a/Documentation/userspace-api/index.rst b/Documentation/userspace-api/index.rst
index 2bc43a658074..c2f067b3de01 100644
--- a/Documentation/userspace-api/index.rst
+++ b/Documentation/userspace-api/index.rst
@@ -44,7 +44,7 @@  Devices and I/O
 
    accelerators/ocxl
    dma-buf-alloc-exchange
-   fwctl
+   fwctl/index
    gpio/index
    iommufd
    media/index
diff --git a/MAINTAINERS b/MAINTAINERS
index 6b52c4168b94..1699316f86ae 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -9377,7 +9377,7 @@  FWCTL SUBSYSTEM
 M:	Jason Gunthorpe <jgg@nvidia.com>
 M:	Saeed Mahameed <saeedm@nvidia.com>
 S:	Maintained
-F:	Documentation/userspace-api/fwctl.rst
+F:	Documentation/userspace-api/fwctl/
 F:	drivers/fwctl/
 F:	include/linux/fwctl.h
 F:	include/uapi/fwctl/