Skip to contentSkip to conversation

Docs/subsystem-apis: Remove '[The ]Linux' prefixes from titles of listed documents

PATCH Applied SeongJae Park 4 participants 4 messages Jan 22, 2023 – Jan 24, 2023

Subsystems (14)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 Docs/subsystem-apis: Remove '[The ]Linux' prefixes from titles of listed documents

Some documents that listed on subsystem-apis have 'Linux' or 'The Linux' title prefixes. It's duplicated information, and makes finding the document of interest with human eyes not easy. Remove the prefixes from the titles.

---
Changes from v1
(https://lore.kernel.org/lkml/[email protected]/)
- Drop second patch (will post later for each subsystem)

 Documentation/PCI/index.rst        | 6 +++---
 Documentation/cpu-freq/index.rst   | 6 +++---
 Documentation/crypto/index.rst     | 6 +++---
 Documentation/driver-api/index.rst | 6 +++---
 Documentation/gpu/index.rst        | 6 +++---
 Documentation/hwmon/index.rst      | 6 +++---
 Documentation/input/index.rst      | 6 +++---
 Documentation/mm/index.rst         | 6 +++---
 Documentation/peci/index.rst       | 6 +++---
 Documentation/scheduler/index.rst  | 6 +++---
 Documentation/scsi/index.rst       | 6 +++---
 Documentation/sound/index.rst      | 6 +++---
 Documentation/virt/index.rst       | 6 +++---
 Documentation/watchdog/index.rst   | 6 +++---
 14 files changed, 42 insertions(+), 42 deletions(-)
Documentation/PCI/index.rst +3 -3
index c17c87af1968..e73f84aebde3 100644
@@ -1,8 +1,8 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-=======================
-Linux PCI Bus Subsystem
-=======================
+=================
+PCI Bus Subsystem
+=================
 
 .. toctree::
    :maxdepth: 2
Documentation/cpu-freq/index.rst +3 -3
index 2fe32dad562a..de25740651f7 100644
@@ -1,8 +1,8 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-==============================================================================
-Linux CPUFreq - CPU frequency and voltage scaling code in the Linux(TM) kernel
-==============================================================================
+========================================================================
+CPUFreq - CPU frequency and voltage scaling code in the Linux(TM) kernel
+========================================================================
 
 Author: Dominik Brodowski  <[email protected]>
 
Documentation/crypto/index.rst +3 -3
index 21338fa92642..da5d5ad2bdf3 100644
@@ -1,6 +1,6 @@
-=======================
-Linux Kernel Crypto API
-=======================
+==========
+Crypto API
+==========
 
 :Author: Stephan Mueller
 :Author: Marek Vasut
Documentation/driver-api/index.rst +3 -3
index d3a58f77328e..b208e0dac3a0 100644
@@ -1,6 +1,6 @@
-========================================
-The Linux driver implementer's API guide
-========================================
+==============================
+Driver implementer's API guide
+==============================
 
 The kernel offers a wide variety of interfaces to support the development
 of device drivers.  This document is an only somewhat organized collection
Documentation/gpu/index.rst +3 -3
index b99dede9a5b1..eee5996acf2c 100644
@@ -1,6 +1,6 @@
-==================================
-Linux GPU Driver Developer's Guide
-==================================
+============================
+GPU Driver Developer's Guide
+============================
 
 .. toctree::
 
Documentation/hwmon/index.rst +3 -3
index fe2cc6b73634..c2b3c1a822dd 100644
@@ -1,6 +1,6 @@
-=========================
-Linux Hardware Monitoring
-=========================
+===================
+Hardware Monitoring
+===================
 
 .. toctree::
    :maxdepth: 1
Documentation/input/index.rst +3 -3
index 9888f5cbf6d5..35581cd18e91 100644
@@ -1,6 +1,6 @@
-=============================
-The Linux Input Documentation
-=============================
+===================
+Input Documentation
+===================
 
 Contents:
 
Documentation/mm/index.rst +3 -3
index 4aa12b8be278..5a94a921ea40 100644
@@ -1,6 +1,6 @@
-=====================================
-Linux Memory Management Documentation
-=====================================
+===============================
+Memory Management Documentation
+===============================
 
 Memory Management Guide
 =======================
Documentation/peci/index.rst +3 -3
index 989de10416e7..930e75217c33 100644
@@ -1,8 +1,8 @@
 .. SPDX-License-Identifier: GPL-2.0-only
 
-====================
-Linux PECI Subsystem
-====================
+==============
+PECI Subsystem
+==============
 
 .. toctree::
 
Documentation/scheduler/index.rst +3 -3
index b430d856056a..1aac972a652f 100644
@@ -1,6 +1,6 @@
-===============
-Linux Scheduler
-===============
+=========
+Scheduler
+=========
 
 .. toctree::
     :maxdepth: 1
Documentation/scsi/index.rst +3 -3
index 7c5f5f8f614e..919f3edfe1bf 100644
@@ -1,8 +1,8 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-====================
-Linux SCSI Subsystem
-====================
+==============
+SCSI Subsystem
+==============
 
 .. toctree::
    :maxdepth: 1
Documentation/sound/index.rst +3 -3
index 4d7d42acf6df..5abed5fc6485 100644
@@ -1,6 +1,6 @@
-===================================
-Linux Sound Subsystem Documentation
-===================================
+=============================
+Sound Subsystem Documentation
+=============================
 
 .. toctree::
    :maxdepth: 2
Documentation/virt/index.rst +3 -3
index 56e003ff28ff..7fb55ae08598 100644
@@ -1,8 +1,8 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-============================
-Linux Virtualization Support
-============================
+======================
+Virtualization Support
+======================
 
 .. toctree::
    :maxdepth: 2
Documentation/watchdog/index.rst +3 -3
index c177645081d8..4603f2511f58 100644
@@ -1,8 +1,8 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-======================
-Linux Watchdog Support
-======================
+================
+Watchdog Support
+================
 
 .. toctree::
     :maxdepth: 1
Signature · 1 line
2.25.1
Acked-by on v2 1/1
#1 lore raw
Quoted 6 lines · SeongJae Park

Some documents that listed on subsystem-apis have 'Linux' or 'The Linux' title prefixes. It's duplicated information, and makes finding the document of interest with human eyes not easy. Remove the prefixes from the titles.

PCI/index.rst change is fine with me:

Quoted 37 lines

---
Changes from v1
(https://lore.kernel.org/lkml/[email protected]/)
- Drop second patch (will post later for each subsystem)

 Documentation/PCI/index.rst        | 6 +++---
 Documentation/cpu-freq/index.rst   | 6 +++---
 Documentation/crypto/index.rst     | 6 +++---
 Documentation/driver-api/index.rst | 6 +++---
 Documentation/gpu/index.rst        | 6 +++---
 Documentation/hwmon/index.rst      | 6 +++---
 Documentation/input/index.rst      | 6 +++---
 Documentation/mm/index.rst         | 6 +++---
 Documentation/peci/index.rst       | 6 +++---
 Documentation/scheduler/index.rst  | 6 +++---
 Documentation/scsi/index.rst       | 6 +++---
 Documentation/sound/index.rst      | 6 +++---
 Documentation/virt/index.rst       | 6 +++---
 Documentation/watchdog/index.rst   | 6 +++---
 14 files changed, 42 insertions(+), 42 deletions(-)
Documentation/PCI/index.rst +3 -3
index c17c87af1968..e73f84aebde3 100644
@@ -1,8 +1,8 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-=======================
-Linux PCI Bus Subsystem
-=======================
+=================
+PCI Bus Subsystem
+=================
 
 .. toctree::
    :maxdepth: 2
maintainer Acked-by on v2 1/1
#2 lore raw
In reply to SeongJae Park
Quoted 6 lines · SeongJae Park

Some documents that listed on subsystem-apis have 'Linux' or 'The Linux' title prefixes.  It's duplicated information, and makes finding the document of interest with human eyes not easy.  Remove the prefixes from the titles.

For Documentation/peci/index.rst

Quoted 20 lines

---
Changes from v1
(https://lore.kernel.org/lkml/[email protected]/)
- Drop second patch (will post later for each subsystem)

 Documentation/PCI/index.rst        | 6 +++---
 Documentation/cpu-freq/index.rst   | 6 +++---
 Documentation/crypto/index.rst     | 6 +++---
 Documentation/driver-api/index.rst | 6 +++---
 Documentation/gpu/index.rst        | 6 +++---
 Documentation/hwmon/index.rst      | 6 +++---
 Documentation/input/index.rst      | 6 +++---
 Documentation/mm/index.rst         | 6 +++---
 Documentation/peci/index.rst       | 6 +++---
 Documentation/scheduler/index.rst  | 6 +++---
 Documentation/scsi/index.rst       | 6 +++---
 Documentation/sound/index.rst      | 6 +++---
 Documentation/virt/index.rst       | 6 +++---
 Documentation/watchdog/index.rst   | 6 +++---

 14 files changed, 42 insertions(+), 42 deletions(-)
maintainer Applied
#3 lore raw
In reply to SeongJae Park
Quoted 11 lines · SeongJae Park

Some documents that listed on subsystem-apis have 'Linux' or 'The Linux' title prefixes. It's duplicated information, and makes finding the document of interest with human eyes not easy. Remove the prefixes from the titles.

---
Changes from v1
(https://lore.kernel.org/lkml/[email protected]/)
- Drop second patch (will post later for each subsystem)

Quoted 15 lines
 Documentation/PCI/index.rst        | 6 +++---
 Documentation/cpu-freq/index.rst   | 6 +++---
 Documentation/crypto/index.rst     | 6 +++---
 Documentation/driver-api/index.rst | 6 +++---
 Documentation/gpu/index.rst        | 6 +++---
 Documentation/hwmon/index.rst      | 6 +++---
 Documentation/input/index.rst      | 6 +++---
 Documentation/mm/index.rst         | 6 +++---
 Documentation/peci/index.rst       | 6 +++---
 Documentation/scheduler/index.rst  | 6 +++---
 Documentation/scsi/index.rst       | 6 +++---
 Documentation/sound/index.rst      | 6 +++---
 Documentation/virt/index.rst       | 6 +++---
 Documentation/watchdog/index.rst   | 6 +++---
 14 files changed, 42 insertions(+), 42 deletions(-)

Applied, thanks.

jon