Skip to contentSkip to conversation

docs: Move the HTE documentation to driver-api/

PATCH In review Jonathan Corbet 3 participants 4 messages Jun 6, 2022 – Jun 13, 2022

Subsystems (3)
lore
Share & tools
lore

Jonathan Corbet

author maintainer
#0 lore raw

PATCH 1/1 docs: Move the HTE documentation to driver-api/

The hardware timestamp engine documentation is driver API material, and really belongs in the driver-API book; move it there.

---
 Documentation/{ => driver-api}/hte/hte.rst          | 0
 Documentation/{ => driver-api}/hte/index.rst        | 0
 Documentation/{ => driver-api}/hte/tegra194-hte.rst | 0
 Documentation/driver-api/index.rst                  | 1 +
 Documentation/index.rst                             | 1 -
 MAINTAINERS                                         | 2 +-
 6 files changed, 2 insertions(+), 2 deletions(-)
 rename Documentation/{ => driver-api}/hte/hte.rst (100%)
 rename Documentation/{ => driver-api}/hte/index.rst (100%)
 rename Documentation/{ => driver-api}/hte/tegra194-hte.rst (100%)
Documentation/driver-api/hte/hte.rst renamed from Documentation/hte/hte.rst +0 -0
similarity index 100%
rename from Documentation/hte/hte.rst
rename to Documentation/driver-api/hte/hte.rst
Documentation/driver-api/hte/index.rst renamed from Documentation/hte/index.rst +0 -0
similarity index 100%
rename from Documentation/hte/index.rst
rename to Documentation/driver-api/hte/index.rst
Documentation/driver-api/hte/tegra194-hte.rst renamed from Documentation/hte/tegra194-hte.rst +0 -0
similarity index 100%
rename from Documentation/hte/tegra194-hte.rst
rename to Documentation/driver-api/hte/tegra194-hte.rst
Documentation/driver-api/index.rst +1 -0
index d76a60d95b58..a6d525cd9fc4 100644
@@ -108,6 +108,7 @@ available subsections can be seen below.
    xilinx/index
    xillybus
    zorro
+   hte/index
 
 .. only::  subproject and html
 
Documentation/index.rst +0 -1
index 8f9be0e658b4..67036a05b771 100644
@@ -137,7 +137,6 @@ needed).
    scheduler/index
    mhi/index
    peci/index
-   hte/index
 
 Architecture-agnostic documentation
 -----------------------------------
MAINTAINERS +1 -1
index a6d3bd9d2a8d..e5b7b78d62d3 100644
@@ -9081,7 +9081,7 @@ HTE SUBSYSTEM
 M:	Dipen Patel <[email protected]>
 S:	Maintained
 F:	Documentation/devicetree/bindings/timestamp/
-F:	Documentation/hte/
+F:	Documentation/driver-api/hte/
 F:	drivers/hte/
 F:	include/linux/hte.h
 
Signature · 1 line
2.35.3
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 65 lines · Jonathan Corbet

The hardware timestamp engine documentation is driver API material, and really belongs in the driver-API book; move it there.

---
 Documentation/{ => driver-api}/hte/hte.rst          | 0
 Documentation/{ => driver-api}/hte/index.rst        | 0
 Documentation/{ => driver-api}/hte/tegra194-hte.rst | 0
 Documentation/driver-api/index.rst                  | 1 +
 Documentation/index.rst                             | 1 -
 MAINTAINERS                                         | 2 +-
 6 files changed, 2 insertions(+), 2 deletions(-)
 rename Documentation/{ => driver-api}/hte/hte.rst (100%)
 rename Documentation/{ => driver-api}/hte/index.rst (100%)
 rename Documentation/{ => driver-api}/hte/tegra194-hte.rst (100%)
Documentation/driver-api/hte/hte.rst renamed from Documentation/hte/hte.rst +0 -0
similarity index 100%
rename from Documentation/hte/hte.rst
rename to Documentation/driver-api/hte/hte.rst
Documentation/driver-api/hte/index.rst renamed from Documentation/hte/index.rst +0 -0
similarity index 100%
rename from Documentation/hte/index.rst
rename to Documentation/driver-api/hte/index.rst
Documentation/driver-api/hte/tegra194-hte.rst renamed from Documentation/hte/tegra194-hte.rst +0 -0
similarity index 100%
rename from Documentation/hte/tegra194-hte.rst
rename to Documentation/driver-api/hte/tegra194-hte.rst
Documentation/driver-api/index.rst +1 -0
index d76a60d95b58..a6d525cd9fc4 100644
@@ -108,6 +108,7 @@ available subsections can be seen below.
    xilinx/index
    xillybus
    zorro
+   hte/index
 
 .. only::  subproject and html
 
Documentation/index.rst +0 -1
index 8f9be0e658b4..67036a05b771 100644
@@ -137,7 +137,6 @@ needed).
    scheduler/index
    mhi/index
    peci/index
-   hte/index
 
 Architecture-agnostic documentation
 -----------------------------------
MAINTAINERS +1 -1
index a6d3bd9d2a8d..e5b7b78d62d3 100644
@@ -9081,7 +9081,7 @@ HTE SUBSYSTEM
 M:	Dipen Patel <[email protected]>
 S:	Maintained
 F:	Documentation/devicetree/bindings/timestamp/
-F:	Documentation/hte/
+F:	Documentation/driver-api/hte/
 F:	drivers/hte/
 F:	include/linux/hte.h
 
author maintainer
#2 lore raw
Quoted 5 lines · Dipen Patel
Quoted 2 lines · Jonathan Corbet

The hardware timestamp engine documentation is driver API material, and really belongs in the driver-API book; move it there.

Thanks...I'll push this through the docs tree unless I hear an objection.

jon

#3 lore raw
Quoted 10 lines · Jonathan Corbet
Quoted 5 lines · Dipen Patel
Quoted 2 lines · Jonathan Corbet

The hardware timestamp engine documentation is driver API material, and really belongs in the driver-API book; move it there.

Thanks...I'll push this through the docs tree unless I hear an objection.

Fine with me. We can coordinate if other documentation related updates surface that may conflict with these.

Thierry