[RFC PATCH 01/17] cxl: update documentation structure in prep for new docs

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Restructure the cxl folder to make adding docs per-page cleaner.

Signed-off-by: Gregory Price <gourry@xxxxxxxxxx>
---
 .../theory-of-operation.rst}                  |  0
 Documentation/driver-api/cxl/index.rst        | 22 ++++++++++++++++---
 .../cxl/{ => linux}/access-coordinates.rst    |  0
 3 files changed, 19 insertions(+), 3 deletions(-)
 rename Documentation/driver-api/cxl/{memory-devices.rst => devices/theory-of-operation.rst} (100%)
 rename Documentation/driver-api/cxl/{ => linux}/access-coordinates.rst (100%)

diff --git a/Documentation/driver-api/cxl/memory-devices.rst b/Documentation/driver-api/cxl/devices/theory-of-operation.rst
similarity index 100%
rename from Documentation/driver-api/cxl/memory-devices.rst
rename to Documentation/driver-api/cxl/devices/theory-of-operation.rst
diff --git a/Documentation/driver-api/cxl/index.rst b/Documentation/driver-api/cxl/index.rst
index 965ba90e8fb7..dfc0a4aa9003 100644
--- a/Documentation/driver-api/cxl/index.rst
+++ b/Documentation/driver-api/cxl/index.rst
@@ -4,12 +4,28 @@
 Compute Express Link
 ====================
 
+CXL device configuration has a complex handoff between platform (Hardware,
+BIOS, EFI), OS (early boot, core kernel, driver), and user policy decisions
+that have impacts on each other.  The docs here break up configurations steps.
+
 .. toctree::
    :maxdepth: 1
+   :caption: Overview
 
-   memory-devices
-   access-coordinates
-
+   self
    maturity-map
 
+.. toctree::
+   :maxdepth: 2
+   :caption: Device Reference
+
+   devices/theory-of-operation
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Linux Kernel Configuration
+
+   linux/access-coordinates
+
+
 .. only::  subproject and html
diff --git a/Documentation/driver-api/cxl/access-coordinates.rst b/Documentation/driver-api/cxl/linux/access-coordinates.rst
similarity index 100%
rename from Documentation/driver-api/cxl/access-coordinates.rst
rename to Documentation/driver-api/cxl/linux/access-coordinates.rst
-- 
2.49.0





[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux