Message ID | 20231027081830.195056-5-vegard.nossum@oracle.com |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:d641:0:b0:403:3b70:6f57 with SMTP id cy1csp443048vqb; Fri, 27 Oct 2023 01:19:32 -0700 (PDT) X-Google-Smtp-Source: AGHT+IHEgzHvhFrMdaY8ipb0ZeO8cgrFBU0rOSDHBbM+eFrWDShr9Yv9/T1BT78b9NRlIF1jWzc9 X-Received: by 2002:a05:6902:1209:b0:da0:9826:d88f with SMTP id s9-20020a056902120900b00da09826d88fmr2267896ybu.29.1698394772065; Fri, 27 Oct 2023 01:19:32 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1698394772; cv=none; d=google.com; s=arc-20160816; b=l2KrLTYDrVKfaWbXmVv+N7MQax52gwrzu/Vu7nXxgQGlItDAEnn/UQ6otlUzXgEjNz dkbVdsl/7IGBAP2TeQBeem6FErG4Ipl1jCfdgMbuRRzZ9bzY0O5KHYJNJjN4ZtbfkEjO zRJvw5x3KMGnS7kTtmePaOnQwbyJzUU9ChpYiG7HIaBjtY27cy/c8r/FsWy3nBR3WEHd x0LjdyQb3BEr7/5W2TomtVwWKZvCBy39+jNl0zAinO+phn3jaaxgf9oVVx5pWSHhjmoV oWmMFLRJpGMTFPVbr3oc/swDpJlIwXOOGrFUmRER1SvK9MAb3P8IG24L3uFlbUkBixIp nIdg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=5c5YvRGx45E/+CpHH1wWVK8msPoSxpNh0E1Lgo5HjKg=; fh=El34TxFoVpUhSyf8TIQ+acmPtnVtKdYoyd6/1Sc9klo=; b=rkkVnIdWP2hBHwI2oV8riexxl0L8ZRP60lx1aWKHooCDNsJwPYnq61pnrc8GSlUg/t jrGNAIwGoQjrEoRRwtOS3k5YSDS7F5S5apHOx9RAow2Sb3I8PmYqgLY9dG41jhL24u6Y 8GEyePxdQ/xLcY4Xn+qtalOXudSf0p0i1la6xOMxqTPE+zIfRcd+5d2+suj9i2mcDJre ZKoT6W7OPlxDB0L0i20sPBfko36vKO1OiDBhTaT0vbF/zfHRvrxytivyna5S7rXX5GAQ Dk8K3VXtwzsCpMFZATsYKOF8495p8wK64rfH0VPRvnJtnGlSG+eihy3oIcwljW5QY83W SnWw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@oracle.com header.s=corp-2023-03-30 header.b="Vg/5HBbf"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.35 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=oracle.com Received: from groat.vger.email (groat.vger.email. [23.128.96.35]) by mx.google.com with ESMTPS id 130-20020a250188000000b00da03fbfa085si1899161ybb.331.2023.10.27.01.19.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 27 Oct 2023 01:19:32 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.35 as permitted sender) client-ip=23.128.96.35; Authentication-Results: mx.google.com; dkim=pass header.i=@oracle.com header.s=corp-2023-03-30 header.b="Vg/5HBbf"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.35 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=oracle.com Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by groat.vger.email (Postfix) with ESMTP id 9965482878BF; Fri, 27 Oct 2023 01:19:25 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at groat.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235101AbjJ0ITF (ORCPT <rfc822;aposhian.dev@gmail.com> + 26 others); Fri, 27 Oct 2023 04:19:05 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59756 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235179AbjJ0ITB (ORCPT <rfc822;linux-kernel@vger.kernel.org>); Fri, 27 Oct 2023 04:19:01 -0400 Received: from mx0a-00069f02.pphosted.com (mx0a-00069f02.pphosted.com [205.220.165.32]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 68FD1FA; Fri, 27 Oct 2023 01:18:59 -0700 (PDT) Received: from pps.filterd (m0333521.ppops.net [127.0.0.1]) by mx0b-00069f02.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 39R5jogH007956; Fri, 27 Oct 2023 08:18:53 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=from : to : cc : subject : date : message-id : in-reply-to : references : mime-version : content-transfer-encoding; s=corp-2023-03-30; bh=5c5YvRGx45E/+CpHH1wWVK8msPoSxpNh0E1Lgo5HjKg=; b=Vg/5HBbfSOSiVtEKMpurNNLEl7cWPNsa2QGjRFCbGOyKSva5U2ffD1x0HjVPVy8NlBZh lqO10Kf5gumPSloaB9U1nGZ7GXXHhCC5YCAgeAS8poyPcV8asvgKiYua/4w0orGsUv3i YDgEmDt6X6aRnEzWbOjaUgDyz3mw/xSC8WR4ZrnIStGyDqC0PzIXqYNGaV/quw4CuxV2 tYEkymQlswAxuixozm1BMfSL/SuCRh6bEY5ZIxEukZrsiBInVygLFt/s4q1D+I9/wMg0 cK28WaDjL2C0xcE6XjpHNQBA53h8b7/Y/XMIaHw7L0lVLPmmYV90JMhrK9tFRQdt2BPu Eg== Received: from phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (phxpaimrmta03.appoci.oracle.com [138.1.37.129]) by mx0b-00069f02.pphosted.com (PPS) with ESMTPS id 3tywtt0yme-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 27 Oct 2023 08:18:53 +0000 Received: from pps.filterd (phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com [127.0.0.1]) by phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (8.17.1.19/8.17.1.19) with ESMTP id 39R6K2cZ009162; Fri, 27 Oct 2023 08:18:52 GMT Received: from pps.reinject (localhost [127.0.0.1]) by phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (PPS) with ESMTPS id 3tywqjeb9d-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 27 Oct 2023 08:18:52 +0000 Received: from phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com [127.0.0.1]) by pps.reinject (8.17.1.5/8.17.1.5) with ESMTP id 39R8Ig9R028975; Fri, 27 Oct 2023 08:18:52 GMT Received: from t460-2.nl.oracle.com (dhcp-10-175-63-126.vpn.oracle.com [10.175.63.126]) by phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (PPS) with ESMTP id 3tywqjeb1g-5; Fri, 27 Oct 2023 08:18:52 +0000 From: Vegard Nossum <vegard.nossum@oracle.com> To: linux-doc@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>, Mauro Carvalho Chehab <mchehab@kernel.org> Cc: Jani Nikula <jani.nikula@intel.com>, linux-kernel@vger.kernel.org, Vegard Nossum <vegard.nossum@oracle.com>, Stephan Mueller <smueller@chronox.de> Subject: [PATCH RFC 04/11] crypto: doc: properly format ToC headings Date: Fri, 27 Oct 2023 10:18:23 +0200 Message-Id: <20231027081830.195056-5-vegard.nossum@oracle.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231027081830.195056-1-vegard.nossum@oracle.com> References: <20231027081830.195056-1-vegard.nossum@oracle.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.272,Aquarius:18.0.987,Hydra:6.0.619,FMLib:17.11.176.26 definitions=2023-10-27_06,2023-10-26_01,2023-05-22_02 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 phishscore=0 mlxlogscore=999 mlxscore=0 spamscore=0 suspectscore=0 adultscore=0 bulkscore=0 malwarescore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2310240000 definitions=main-2310270071 X-Proofpoint-GUID: QehSy-H1XCn1uln3sRzJuY2bFJDiWyhb X-Proofpoint-ORIG-GUID: QehSy-H1XCn1uln3sRzJuY2bFJDiWyhb X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIMWL_WL_MED,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on groat.vger.email Precedence: bulk List-ID: <linux-kernel.vger.kernel.org> X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (groat.vger.email [0.0.0.0]); Fri, 27 Oct 2023 01:19:25 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1780895996673752139 X-GMAIL-MSGID: 1780895996673752139 |
Series |
use toctree :caption: for ToC headings
|
|
Commit Message
Vegard Nossum
Oct. 27, 2023, 8:18 a.m. UTC
"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@kernel.org>
Cc: Stephan Mueller <smueller@chronox.de>
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
---
Documentation/crypto/api.rst | 5 +----
Documentation/crypto/index.rst | 5 +----
2 files changed, 2 insertions(+), 8 deletions(-)
diff --git a/Documentation/crypto/api.rst b/Documentation/crypto/api.rst index b91b31736df8..ff31c30561d4 100644 --- a/Documentation/crypto/api.rst +++ b/Documentation/crypto/api.rst @@ -1,11 +1,8 @@ Programming Interface ===================== -.. class:: toc-title - - Table of contents - .. toctree:: + :caption: Table of contents :maxdepth: 2 api-skcipher diff --git a/Documentation/crypto/index.rst b/Documentation/crypto/index.rst index da5d5ad2bdf3..10647c5ae2ea 100644 --- a/Documentation/crypto/index.rst +++ b/Documentation/crypto/index.rst @@ -9,11 +9,8 @@ This documentation outlines the Linux kernel crypto API with its concepts, details about developing cipher implementations, employment of the API for cryptographic use cases, as well as programming examples. -.. class:: toc-title - - Table of contents - .. toctree:: + :caption: Table of contents :maxdepth: 2 intro