linux-kernel - [PATCH RFC 02/11] doc: userspace-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-3-vegard.nossum@oracle.com>
Date:   Fri, 27 Oct 2023 10:18:21 +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>,
        Rui Li <me@...ui.org>, Yanteng Si <siyanteng@...ngson.cn>,
        Wu XiangCheng <bobwxc@...il.cn>
Subject: [PATCH RFC 02/11] doc: userspace-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: Rui Li <me@...ui.org>
Cc: Yanteng Si <siyanteng@...ngson.cn>
Cc: Wu XiangCheng <bobwxc@...il.cn>
Signed-off-by: Vegard Nossum <vegard.nossum@...cle.com>
---
 Documentation/translations/zh_CN/userspace-api/index.rst | 5 +----
 Documentation/userspace-api/index.rst                    | 5 +----
 2 files changed, 2 insertions(+), 8 deletions(-)

diff --git a/Documentation/translations/zh_CN/userspace-api/index.rst b/Documentation/translations/zh_CN/userspace-api/index.rst
index 5dc0f2e69c17..5b14721c8264 100644
--- a/Documentation/translations/zh_CN/userspace-api/index.rst
+++ b/Documentation/translations/zh_CN/userspace-api/index.rst
@@ -17,11 +17,8 @@ Linux 内核用户空间API指南
 在代码树中仍然可以找到有关用户空间的部分信息。这个手册意在成为这些信息
 聚集的地方。
 
-.. class:: toc-title
-
-	   目录
-
 .. toctree::
+   :caption: 目录
    :maxdepth: 2
 
    no_new_privs
diff --git a/Documentation/userspace-api/index.rst b/Documentation/userspace-api/index.rst
index 72a65db0c498..5b32a461c2dd 100644
--- a/Documentation/userspace-api/index.rst
+++ b/Documentation/userspace-api/index.rst
@@ -9,11 +9,8 @@ While much of the kernel's user-space API is documented elsewhere
 also be found in the kernel tree itself.  This manual is intended to be the
 place where this information is gathered.
 
-.. class:: toc-title
-
-	   Table of contents
-
 .. toctree::
+   :caption: Table of contents
    :maxdepth: 2
 
    no_new_privs
-- 
2.34.1