linux-kernel - [PATCH RFC 06/11] docs: driver-api: properly format ToC headings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-Id: <20231027081830.195056-7-vegard.nossum@oracle.com>
Date:   Fri, 27 Oct 2023 10:18:25 +0200
From:   Vegard Nossum <vegard.nossum@...cle.com>
To:     linux-doc@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Mauro Carvalho Chehab <mchehab@...nel.org>
Cc:     Jani Nikula <jani.nikula@...el.com>, linux-kernel@...r.kernel.org,
        Vegard Nossum <vegard.nossum@...cle.com>,
        Richard Cochran <richardcochran@...il.com>,
        SeongJae Park <sj@...nel.org>,
        Hans de Goede <hdegoede@...hat.com>,
        Armin Wolf <W_Armin@....de>,
        Iwona Winiarska <iwona.winiarska@...el.com>,
        Ricardo Cañuelo <ricardo.canuelo@...labora.com>,
        Tomas Winkler <tomas.winkler@...el.com>,
        linux-media@...r.kernel.org, Yanteng Si <siyanteng@...ngson.cn>,
        Alex Shi <alexs@...nel.org>, Wu XiangCheng <bobwxc@...il.cn>
Subject: [PATCH RFC 06/11] docs: driver-api: properly format ToC headings

"class:: toc-title" was a workaround for older Sphinx versions that are
no longer supported.

The canonical way to add a heading to the ToC is to use :caption:.
Do that.

Cc: Mauro Carvalho Chehab <mchehab@...nel.org>
Cc: Richard Cochran <richardcochran@...il.com>
Cc: SeongJae Park <sj@...nel.org>
Cc: Hans de Goede <hdegoede@...hat.com>
Cc: Armin Wolf <W_Armin@....de>
Cc: Iwona Winiarska <iwona.winiarska@...el.com>
Cc: "Ricardo Cañuelo" <ricardo.canuelo@...labora.com>
Cc: Tomas Winkler <tomas.winkler@...el.com>
Cc: linux-media@...r.kernel.org
Cc: Yanteng Si <siyanteng@...ngson.cn>
Cc: Alex Shi <alexs@...nel.org>
Cc: Wu XiangCheng <bobwxc@...il.cn>
Signed-off-by: Vegard Nossum <vegard.nossum@...cle.com>
---
 Documentation/driver-api/index.rst                         | 5 +----
 Documentation/driver-api/media/index.rst                   | 7 +------
 Documentation/driver-api/mei/index.rst                     | 7 +------
 Documentation/driver-api/pci/index.rst                     | 5 +----
 Documentation/translations/zh_CN/driver-api/gpio/index.rst | 3 +--
 Documentation/translations/zh_CN/driver-api/index.rst      | 5 +----
 6 files changed, 6 insertions(+), 26 deletions(-)

diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 1e16a40da3ba..4540f79a34a9 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -9,11 +9,8 @@ of device drivers.  This document is an only somewhat organized collection
 of some of those interfaces — it will hopefully get better over time!  The
 available subsections can be seen below.
 
-.. class:: toc-title
-
-	   Table of contents
-
 .. toctree::
+   :caption: Table of contents
    :maxdepth: 2
 
    driver-model/index
diff --git a/Documentation/driver-api/media/index.rst b/Documentation/driver-api/media/index.rst
index 08e206567408..d5593182a3f9 100644
--- a/Documentation/driver-api/media/index.rst
+++ b/Documentation/driver-api/media/index.rst
@@ -20,13 +20,8 @@ Documentation/userspace-api/media/index.rst
   - for the userspace APIs used on media devices.
 
 
-.. only:: html
-
-   .. class:: toc-title
-
-        Table of Contents
-
 .. toctree::
+    :caption: Table of Contents
     :maxdepth: 5
     :numbered:
 
diff --git a/Documentation/driver-api/mei/index.rst b/Documentation/driver-api/mei/index.rst
index 3a22b522ee78..eae6f18f18cf 100644
--- a/Documentation/driver-api/mei/index.rst
+++ b/Documentation/driver-api/mei/index.rst
@@ -9,13 +9,8 @@ Intel(R) Management Engine Interface (Intel(R) MEI)
 **Copyright** |copy| 2019 Intel Corporation
 
 
-.. only:: html
-
-   .. class:: toc-title
-
-        Table of Contents
-
 .. toctree::
+   :caption: Table of Contents
    :maxdepth: 3
 
    mei
diff --git a/Documentation/driver-api/pci/index.rst b/Documentation/driver-api/pci/index.rst
index c6cf1fef61ce..a38e475cdbe3 100644
--- a/Documentation/driver-api/pci/index.rst
+++ b/Documentation/driver-api/pci/index.rst
@@ -4,11 +4,8 @@
 The Linux PCI driver implementer's API guide
 ============================================
 
-.. class:: toc-title
-
-	   Table of contents
-
 .. toctree::
+   :caption: Table of contents
    :maxdepth: 2
 
    pci
diff --git a/Documentation/translations/zh_CN/driver-api/gpio/index.rst b/Documentation/translations/zh_CN/driver-api/gpio/index.rst
index 9ab64e94aced..9a6a14162a6c 100644
--- a/Documentation/translations/zh_CN/driver-api/gpio/index.rst
+++ b/Documentation/translations/zh_CN/driver-api/gpio/index.rst
@@ -14,9 +14,8 @@
 通用型输入/输出（GPIO）
 =======================
 
-目录:
-
 .. toctree::
+   :caption: 目录
    :maxdepth: 2
 
    legacy
diff --git a/Documentation/translations/zh_CN/driver-api/index.rst b/Documentation/translations/zh_CN/driver-api/index.rst
index ba354e1f4e6d..92ff1b7fc3d3 100644
--- a/Documentation/translations/zh_CN/driver-api/index.rst
+++ b/Documentation/translations/zh_CN/driver-api/index.rst
@@ -17,11 +17,8 @@ Linux驱动实现者的API指南
 内核提供了各种各样的接口来支持设备驱动的开发。这份文档只是对其中一些接口进行了
 一定程度的整理——希望随着时间的推移，它能变得更好！可用的小节可以在下面看到。
 
-.. class:: toc-title
-
-	   目录列表：
-
 .. toctree::
+   :caption: 目录列表
    :maxdepth: 2
 
    gpio/index
-- 
2.34.1