[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.
Signed-off-by: SeongJae Park sj@kernel.org --- Changes from v1 (https://lore.kernel.org/lkml/20230114194741.115855-1-sj@kernel.org/) - 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(-)
diff --git a/Documentation/PCI/index.rst b/Documentation/PCI/index.rst index c17c87af1968..e73f84aebde3 100644 --- a/Documentation/PCI/index.rst +++ b/Documentation/PCI/index.rst @@ -1,8 +1,8 @@ .. SPDX-License-Identifier: GPL-2.0
-======================= -Linux PCI Bus Subsystem -======================= +================= +PCI Bus Subsystem +=================
.. toctree:: :maxdepth: 2 diff --git a/Documentation/cpu-freq/index.rst b/Documentation/cpu-freq/index.rst index 2fe32dad562a..de25740651f7 100644 --- a/Documentation/cpu-freq/index.rst +++ b/Documentation/cpu-freq/index.rst @@ -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 linux@brodo.de
diff --git a/Documentation/crypto/index.rst b/Documentation/crypto/index.rst index 21338fa92642..da5d5ad2bdf3 100644 --- a/Documentation/crypto/index.rst +++ b/Documentation/crypto/index.rst @@ -1,6 +1,6 @@ -======================= -Linux Kernel Crypto API -======================= +========== +Crypto API +==========
:Author: Stephan Mueller :Author: Marek Vasut diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst index d3a58f77328e..b208e0dac3a0 100644 --- a/Documentation/driver-api/index.rst +++ b/Documentation/driver-api/index.rst @@ -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 diff --git a/Documentation/gpu/index.rst b/Documentation/gpu/index.rst index b99dede9a5b1..eee5996acf2c 100644 --- a/Documentation/gpu/index.rst +++ b/Documentation/gpu/index.rst @@ -1,6 +1,6 @@ -================================== -Linux GPU Driver Developer's Guide -================================== +============================ +GPU Driver Developer's Guide +============================
.. toctree::
diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst index fe2cc6b73634..c2b3c1a822dd 100644 --- a/Documentation/hwmon/index.rst +++ b/Documentation/hwmon/index.rst @@ -1,6 +1,6 @@ -========================= -Linux Hardware Monitoring -========================= +=================== +Hardware Monitoring +===================
.. toctree:: :maxdepth: 1 diff --git a/Documentation/input/index.rst b/Documentation/input/index.rst index 9888f5cbf6d5..35581cd18e91 100644 --- a/Documentation/input/index.rst +++ b/Documentation/input/index.rst @@ -1,6 +1,6 @@ -============================= -The Linux Input Documentation -============================= +=================== +Input Documentation +===================
Contents:
diff --git a/Documentation/mm/index.rst b/Documentation/mm/index.rst index 4aa12b8be278..5a94a921ea40 100644 --- a/Documentation/mm/index.rst +++ b/Documentation/mm/index.rst @@ -1,6 +1,6 @@ -===================================== -Linux Memory Management Documentation -===================================== +=============================== +Memory Management Documentation +===============================
Memory Management Guide ======================= diff --git a/Documentation/peci/index.rst b/Documentation/peci/index.rst index 989de10416e7..930e75217c33 100644 --- a/Documentation/peci/index.rst +++ b/Documentation/peci/index.rst @@ -1,8 +1,8 @@ .. SPDX-License-Identifier: GPL-2.0-only
-==================== -Linux PECI Subsystem -==================== +============== +PECI Subsystem +==============
.. toctree::
diff --git a/Documentation/scheduler/index.rst b/Documentation/scheduler/index.rst index b430d856056a..1aac972a652f 100644 --- a/Documentation/scheduler/index.rst +++ b/Documentation/scheduler/index.rst @@ -1,6 +1,6 @@ -=============== -Linux Scheduler -=============== +========= +Scheduler +=========
.. toctree:: :maxdepth: 1 diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst index 7c5f5f8f614e..919f3edfe1bf 100644 --- a/Documentation/scsi/index.rst +++ b/Documentation/scsi/index.rst @@ -1,8 +1,8 @@ .. SPDX-License-Identifier: GPL-2.0
-==================== -Linux SCSI Subsystem -==================== +============== +SCSI Subsystem +==============
.. toctree:: :maxdepth: 1 diff --git a/Documentation/sound/index.rst b/Documentation/sound/index.rst index 4d7d42acf6df..5abed5fc6485 100644 --- a/Documentation/sound/index.rst +++ b/Documentation/sound/index.rst @@ -1,6 +1,6 @@ -=================================== -Linux Sound Subsystem Documentation -=================================== +============================= +Sound Subsystem Documentation +=============================
.. toctree:: :maxdepth: 2 diff --git a/Documentation/virt/index.rst b/Documentation/virt/index.rst index 56e003ff28ff..7fb55ae08598 100644 --- a/Documentation/virt/index.rst +++ b/Documentation/virt/index.rst @@ -1,8 +1,8 @@ .. SPDX-License-Identifier: GPL-2.0
-============================ -Linux Virtualization Support -============================ +====================== +Virtualization Support +======================
.. toctree:: :maxdepth: 2 diff --git a/Documentation/watchdog/index.rst b/Documentation/watchdog/index.rst index c177645081d8..4603f2511f58 100644 --- a/Documentation/watchdog/index.rst +++ b/Documentation/watchdog/index.rst @@ -1,8 +1,8 @@ .. SPDX-License-Identifier: GPL-2.0
-====================== -Linux Watchdog Support -====================== +================ +Watchdog Support +================
.. toctree:: :maxdepth: 1
On Sun, Jan 22, 2023 at 06:48:34PM +0000, SeongJae Park wrote:
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.
Signed-off-by: SeongJae Park sj@kernel.org
PCI/index.rst change is fine with me:
Acked-by: Bjorn Helgaas bhelgaas@google.com
Changes from v1 (https://lore.kernel.org/lkml/20230114194741.115855-1-sj@kernel.org/)
- 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(-)
diff --git a/Documentation/PCI/index.rst b/Documentation/PCI/index.rst index c17c87af1968..e73f84aebde3 100644 --- a/Documentation/PCI/index.rst +++ b/Documentation/PCI/index.rst @@ -1,8 +1,8 @@ .. SPDX-License-Identifier: GPL-2.0
-=======================
-Linux PCI Bus Subsystem
+================= +PCI Bus Subsystem +=================
.. toctree:: :maxdepth: 2
On Sun, 2023-01-22 at 18:48 +0000, SeongJae Park wrote:
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.
Signed-off-by: SeongJae Park sj@kernel.org
For Documentation/peci/index.rst
Acked-by: Iwona Winiarska iwona.winiarska@intel.com
Changes from v1 (https://lore.kernel.org/lkml/20230114194741.115855-1-sj@kernel.org/)
- 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(-)
SeongJae Park sj@kernel.org writes:
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.
Signed-off-by: SeongJae Park sj@kernel.org
Changes from v1 (https://lore.kernel.org/lkml/20230114194741.115855-1-sj@kernel.org/)
- 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(-)
Applied, thanks.
jon
participants (4)
-
Bjorn Helgaas
-
Jonathan Corbet
-
SeongJae Park
-
Winiarska, Iwona