From patchwork Fri Oct 27 08:18:28 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Vegard Nossum X-Patchwork-Id: 158816 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:d641:0:b0:403:3b70:6f57 with SMTP id cy1csp443090vqb; Fri, 27 Oct 2023 01:19:37 -0700 (PDT) X-Google-Smtp-Source: AGHT+IETNFntDrRPbwGU4BiceFfR76wGPm6RTbr4E6/TiGGgjxzOG2tW4Bfk4OxvOzv22Kabf2pU X-Received: by 2002:a67:c199:0:b0:457:e9fe:66b with SMTP id h25-20020a67c199000000b00457e9fe066bmr2235935vsj.2.1698394777205; Fri, 27 Oct 2023 01:19:37 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1698394777; cv=none; d=google.com; s=arc-20160816; b=icCWmJ4bi0PTAAxVsv2qq/PuHSTXfBmbmpSPlUcAfuiKFRI4oWqBO6wwrSoshIkrMG Hyxva2qFVLncm1VbD6eBi1F65m8epNuolrLv5LkQX4KTSvPseabWc5ONXy8lxPIV7LOS Y7sXb/gr6NZsCHiVu4Ax9p7KK0F7IdgFrctMWoi+k8QiSZz5mY3tT8q+7jNujoKXarEj fM83P0Rv8x+7t+qYl7HUL1+8B1A5yEGnsggsyDItWmufHZfvnWsoGrer3D1DXE8Y5EGU LzqlbRB4dqcpz4P0mxOYF5cmyI2HDaUrX1zHV45G0CqggMiBhqgtGcNO6elQMx/lebQZ ddJw== 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=DXSUD6D4gKvGLEozl2neVPvk09OeuaDfgn2a+Uvpugo=; fh=8pnP4nTpyCpnUoeLMRmzXBJYejrl7xCpTckXy5MI3zw=; b=aAy9pH6NSpOkTdUABD3q9NhQDBhWxinoNMLZXKnaODeeEdXl+PyguwJR2PH3BwdgfQ 56uwZmVcLR+a4cW/9SjsSqhtmcvqJ6vnqRQuZzmEDqBTCfYdLRh7CpwLez1KFery6nRd PHbGfLHrFdnpp0C3gcziMhKOa+iLXj1wUMrPCLxOexWhsnB0wTH1IjoiqUzOW5KRHRMS hRyyqHdvQdjuqX+bKxB1Gn4ALJtR/WEE0sUZeGP9DJa3PtiSUkVCbf72MX0HudTS8c7C yFGfMZGATEa7Q0w87nhu6VKC6NCm67j3H6ixV5TYv7iUJ0hgRj7eEw2jOALd4A8hh9Hc BDWA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@oracle.com header.s=corp-2023-03-30 header.b="4Kpy5f/I"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 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 snail.vger.email (snail.vger.email. [23.128.96.37]) by mx.google.com with ESMTPS id z6-20020a258686000000b00d9cacabec21si1961163ybk.223.2023.10.27.01.19.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 27 Oct 2023 01:19:37 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) client-ip=23.128.96.37; Authentication-Results: mx.google.com; dkim=pass header.i=@oracle.com header.s=corp-2023-03-30 header.b="4Kpy5f/I"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 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 snail.vger.email (Postfix) with ESMTP id 083F182BB542; Fri, 27 Oct 2023 01:19:36 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at snail.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235163AbjJ0IT3 (ORCPT + 26 others); Fri, 27 Oct 2023 04:19:29 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59766 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235198AbjJ0ITU (ORCPT ); Fri, 27 Oct 2023 04:19:20 -0400 Received: from mx0b-00069f02.pphosted.com (mx0b-00069f02.pphosted.com [205.220.177.32]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9A32CD4D; Fri, 27 Oct 2023 01:19:15 -0700 (PDT) Received: from pps.filterd (m0246632.ppops.net [127.0.0.1]) by mx0b-00069f02.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 39R5i7VK020414; Fri, 27 Oct 2023 08:19:10 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=DXSUD6D4gKvGLEozl2neVPvk09OeuaDfgn2a+Uvpugo=; b=4Kpy5f/I89OCxsliZBqE9SKvfTop/EnnMkIkvl+APmvoLPgZZjNDz/qV3LdF83fRv2M3 pmYakKDxbAutVzK+IIjgrn40F/FqJgDVlvyPavy34fgyAdj6dFYy1jmLOiVKONxeYCGt EKZVTMgEqfGs8ggYWyyTa0bxtUmiUyFLV8GH1gLqxumxydAFeI6AC8NxX2L5mjNQWSxE nYTc43XbG9bH/rsF2vQRdYd35P1d5Ce9kgGsDRYO2hzCemIzeiPPP8nFgoFr1fq9gPp7 76sCvrZvinMeb8UX7YMBMQxGxHqA7brRPlXQW1aZet5GdCp0bZRyHy9bZouUrlGIo2YI TA== Received: from phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (phxpaimrmta03.appoci.oracle.com [138.1.37.129]) by mx0b-00069f02.pphosted.com (PPS) with ESMTPS id 3tyxge0vaf-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 27 Oct 2023 08:19:09 +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 39R6Jdh0009176; Fri, 27 Oct 2023 08:19:08 GMT Received: from pps.reinject (localhost [127.0.0.1]) by phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (PPS) with ESMTPS id 3tywqjebfh-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 27 Oct 2023 08:19:08 +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 39R8Ig9b028975; Fri, 27 Oct 2023 08:19:08 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-10; Fri, 27 Oct 2023 08:19:08 +0000 From: Vegard Nossum To: linux-doc@vger.kernel.org, Jonathan Corbet , Mauro Carvalho Chehab Cc: Jani Nikula , linux-kernel@vger.kernel.org, Vegard Nossum , linux-media@vger.kernel.org Subject: [PATCH RFC 09/11] media: doc: properly format ToC headings Date: Fri, 27 Oct 2023 10:18:28 +0200 Message-Id: <20231027081830.195056-10-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 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: E4AH135QpSPthVEXi7VDe67BysDZfm3d X-Proofpoint-ORIG-GUID: E4AH135QpSPthVEXi7VDe67BysDZfm3d X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF, RCVD_IN_DNSWL_BLOCKED,RCVD_IN_MSPIKE_H5,RCVD_IN_MSPIKE_WL, SPF_HELO_NONE,SPF_NONE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (snail.vger.email [0.0.0.0]); Fri, 27 Oct 2023 01:19:36 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1780896002257822572 X-GMAIL-MSGID: 1780896002257822572 "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 Cc: linux-media@vger.kernel.org Signed-off-by: Vegard Nossum --- Documentation/userspace-api/media/cec/cec-api.rst | 7 +------ Documentation/userspace-api/media/drivers/index.rst | 7 +------ Documentation/userspace-api/media/dvb/dvbapi.rst | 7 +------ Documentation/userspace-api/media/index.rst | 7 +------ .../userspace-api/media/mediactl/media-controller.rst | 7 +------ .../userspace-api/media/rc/remote_controllers.rst | 7 +------ Documentation/userspace-api/media/v4l/v4l2.rst | 7 +------ 7 files changed, 7 insertions(+), 42 deletions(-) diff --git a/Documentation/userspace-api/media/cec/cec-api.rst b/Documentation/userspace-api/media/cec/cec-api.rst index 4d229ed8a1d9..578303d484f3 100644 --- a/Documentation/userspace-api/media/cec/cec-api.rst +++ b/Documentation/userspace-api/media/cec/cec-api.rst @@ -10,13 +10,8 @@ Part V - Consumer Electronics Control API This part describes the CEC: Consumer Electronics Control -.. only:: html - - .. class:: toc-title - - Table of Contents - .. toctree:: + :caption: Table of Contents :maxdepth: 5 :numbered: diff --git a/Documentation/userspace-api/media/drivers/index.rst b/Documentation/userspace-api/media/drivers/index.rst index 6708d649afd7..d4338dc506dd 100644 --- a/Documentation/userspace-api/media/drivers/index.rst +++ b/Documentation/userspace-api/media/drivers/index.rst @@ -21,13 +21,8 @@ more details. For more details see the file COPYING in the source distribution of Linux. -.. only:: html - - .. class:: toc-title - - Table of Contents - .. toctree:: + :caption: Table of Contents :maxdepth: 5 :numbered: diff --git a/Documentation/userspace-api/media/dvb/dvbapi.rst b/Documentation/userspace-api/media/dvb/dvbapi.rst index 1dda69343f34..4ac0c1bc54ca 100644 --- a/Documentation/userspace-api/media/dvb/dvbapi.rst +++ b/Documentation/userspace-api/media/dvb/dvbapi.rst @@ -27,13 +27,8 @@ Part II - Digital TV API **Version 5.10** -.. only:: html - - .. class:: toc-title - - Table of Contents - .. toctree:: + :caption: Table of Contents :maxdepth: 5 :numbered: diff --git a/Documentation/userspace-api/media/index.rst b/Documentation/userspace-api/media/index.rst index d839904be085..337ef6c7c47f 100644 --- a/Documentation/userspace-api/media/index.rst +++ b/Documentation/userspace-api/media/index.rst @@ -21,13 +21,8 @@ Documentation/driver-api/media/index.rst media devices; -.. only:: html - - .. class:: toc-title - - Table of Contents - .. toctree:: + :caption: Table of Contents :maxdepth: 1 intro diff --git a/Documentation/userspace-api/media/mediactl/media-controller.rst b/Documentation/userspace-api/media/mediactl/media-controller.rst index 508dd693bf6c..73a87f82f92d 100644 --- a/Documentation/userspace-api/media/mediactl/media-controller.rst +++ b/Documentation/userspace-api/media/mediactl/media-controller.rst @@ -7,13 +7,8 @@ Part IV - Media Controller API ############################## -.. only:: html - - .. class:: toc-title - - Table of Contents - .. toctree:: + :caption: Table of Contents :maxdepth: 5 :numbered: diff --git a/Documentation/userspace-api/media/rc/remote_controllers.rst b/Documentation/userspace-api/media/rc/remote_controllers.rst index f89291838637..483f9ae92a90 100644 --- a/Documentation/userspace-api/media/rc/remote_controllers.rst +++ b/Documentation/userspace-api/media/rc/remote_controllers.rst @@ -7,13 +7,8 @@ Part III - Remote Controller API ################################ -.. only:: html - - .. class:: toc-title - - Table of Contents - .. toctree:: + :caption: Table of Contents :maxdepth: 5 :numbered: diff --git a/Documentation/userspace-api/media/v4l/v4l2.rst b/Documentation/userspace-api/media/v4l/v4l2.rst index ad7a2bf0cf26..cf8ae56a008c 100644 --- a/Documentation/userspace-api/media/v4l/v4l2.rst +++ b/Documentation/userspace-api/media/v4l/v4l2.rst @@ -11,13 +11,8 @@ This part describes the Video for Linux API version 2 (V4L2 API) specification. **Revision 4.5** -.. only:: html - - .. class:: toc-title - - Table of Contents - .. toctree:: + :caption: Table of Contents :numbered: :maxdepth: 5