From patchwork Wed Feb 15 00:57:26 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 57297 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:eb09:0:0:0:0:0 with SMTP id s9csp3293009wrn; Tue, 14 Feb 2023 17:06:52 -0800 (PST) X-Google-Smtp-Source: AK7set/U/sZB6Lm3rBxenMMCW7AsL9caswWENxNL5cU24pzXKrv5rA4ZHtsVPgiZm6r8rSgHuIov X-Received: by 2002:aa7:ca51:0:b0:4ab:2423:e310 with SMTP id j17-20020aa7ca51000000b004ab2423e310mr231493edt.28.1676423212578; Tue, 14 Feb 2023 17:06:52 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1676423212; cv=none; d=google.com; s=arc-20160816; b=xb7Ql41iJGmVgdVWdCZDABg/N2e5OSrtONy9190CvkCKysLBBEvmDT66B2iwaOcVuF rai7ihXD9+KCMjd9HKW7ubJ6l9X3l2dSC0DCw1xCJtyNCMsT2WvN2OaAs+K93jZRElOj EhzJoeLsNZ5zyFiHX3eAIFBaG6mYBgHA4D2Nu38gYShvenp/xKBNJr0Gk55MmwfuaIpx NSshxSOMC4y+FpExG7Lhji2tBFd4HVdnjFkVGiWetIuGnNZlZ8evxIgiF6dvYyGCDrhO 4IBDrNkKh+l6rj4vxkwTk8B+lq1dvTEyvzQ81AoiAVQ4sYmIYaBrtjwkNFyfC0Anf1cG RjTg== 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 :message-id:date:subject:cc:to:from:dkim-signature; bh=PPu6OIyOMqF/ZcmFoHtDoinYfQ4Lxp1RRxh5EWluloQ=; b=X2SeRnK6qntdIBzz7CA0m8mImPTANm/KIM4IDmeONANNQxf4gpFcjxxFCXjCYcrLqU QmeCwHsRB9vWU0UVsIe64yKtpt74jhfQ6wSuS213/4Mk/JD1YdV9ANLzJNRUSNH5A3Pj jAqbeD3DMrfOvmcC88gdigB48GG5AYGplM8HkwCDdtG+If3Q16+frWLBPuRFbmYRupIZ os6TyY1PkIGCfgR9gVpk4BLhatNWzhlEHZYxLXY8e8GVujmFF/Rm/QM18E7xNXEn1wOm x5zUwGy8I2tfskGvhHChOJODhsisxOlIitYyK3sS09OQoNum8uJQzznwuT8v1YAuWQ97 qWXg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b="EAOEZi3/"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id l7-20020a056402028700b004ac089b971dsi14817280edv.114.2023.02.14.17.06.28; Tue, 14 Feb 2023 17:06:52 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b="EAOEZi3/"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232248AbjBOA5c (ORCPT + 99 others); Tue, 14 Feb 2023 19:57:32 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:43930 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229568AbjBOA5b (ORCPT ); Tue, 14 Feb 2023 19:57:31 -0500 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A5A8E2BEE3; Tue, 14 Feb 2023 16:57:28 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: Content-Type:MIME-Version:Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To: Content-ID:Content-Description:In-Reply-To:References; bh=PPu6OIyOMqF/ZcmFoHtDoinYfQ4Lxp1RRxh5EWluloQ=; b=EAOEZi3/xDvaWrd4Q5sRqNuI/m UqQr/xJPQyoX9lZub4J29jyxuzP8xqBMhvXLSoqbkZIT2+hWDK+BTPgoAJYfuzuLEZZqbCjjnS0Qv LL+cHNo3RUCLJclC78Tgn+/iVIKbjmOE5VlDcvlUbZRlGvLYe7MHPXdjHJ4hqUf7tOZWkEtYbS0M/ ZbWReOC6FaGl/889SZAlJ2wJ1I7OwykMPIeozEvxtKvVfCVGwKOyLf24nNxt4Ek9IJkcfeGnFSqGf 2uIWqSqpf8/9ds7L66WhxTxcqV6ufzwcY5aNqrhG199BTNZAWZhU+mPXEZDzlfeaOAaNR+6YBFjlD WrO0xP+g==; Received: from [2601:1c2:980:9ec0::df2f] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.94.2 #2 (Red Hat Linux)) id 1pS66y-0046wd-8E; Wed, 15 Feb 2023 00:57:28 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Jonathan Corbet , linux-doc@vger.kernel.org, Mauro Carvalho Chehab Subject: [PATCH] Documentation: front page: use recommended heading adornments Date: Tue, 14 Feb 2023 16:57:26 -0800 Message-Id: <20230215005726.27320-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.39.1 MIME-Version: 1.0 X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,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-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1757857146770473622?= X-GMAIL-MSGID: =?utf-8?q?1757857146770473622?= Convert the Documentation front page to use the heading adornments that are documented in doc-guide/sphinx.rst for document title and chapters. I.e., convert most section headings to chapters. This leaves "Indices and tables" as a chapter entry at the same level as the other chapters. The only visual difference from before to after is that the "Indices and tables" heading is smaller and has more vertical whitespace preceding it (although that may depend on the web browser being used). Fixes: 0c7b4366f1ab ("docs: Rewrite the front page") Fixes: bffac837f3a3 ("docs-rst: convert sh book to ReST") Fixes: 8e2a46a40fa7 ("docs: move remaining stuff under Documentation/*.txt to Documentation/staging") Signed-off-by: Randy Dunlap Cc: Jonathan Corbet Cc: linux-doc@vger.kernel.org Cc: Mauro Carvalho Chehab --- Documentation/index.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff -- a/Documentation/index.rst b/Documentation/index.rst --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -2,6 +2,7 @@ .. _linux_doc: +============================== The Linux Kernel documentation ============================== @@ -13,7 +14,7 @@ documentation are welcome; join the linu you want to help out. Working with the development community --------------------------------------- +====================================== The essential guides for interacting with the kernel's development community and getting your work upstream. @@ -29,7 +30,7 @@ community and getting your work upstream Internal API manuals --------------------- +==================== Manuals for use by developers working to interface with the rest of the kernel. @@ -43,7 +44,7 @@ kernel. Locking in the kernel Development tools and processes -------------------------------- +=============================== Various other manuals with useful information for all kernel developers. @@ -62,7 +63,7 @@ Various other manuals with useful inform User-oriented documentation ---------------------------- +=========================== The following manuals are written for *users* of the kernel — those who are trying to get it to work optimally on a given system and application @@ -81,7 +82,7 @@ See also: the `Linux man pages