From nobody Tue Jun 23 13:16:27 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 00771C433EF for ; Mon, 28 Mar 2022 06:51:05 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238592AbiC1Gwo (ORCPT ); Mon, 28 Mar 2022 02:52:44 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36808 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S238563AbiC1Gwf (ORCPT ); Mon, 28 Mar 2022 02:52:35 -0400 Received: from mail-pg1-x52e.google.com (mail-pg1-x52e.google.com [IPv6:2607:f8b0:4864:20::52e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6611032982; Sun, 27 Mar 2022 23:50:55 -0700 (PDT) Received: by mail-pg1-x52e.google.com with SMTP id k14so11557541pga.0; Sun, 27 Mar 2022 23:50:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=ulRhUBB/501Y6zLj3F+koUiiEJffcO52ksrV1+fMBQw=; b=B5TYK/Lj1riWa8lfJJsWT8BgE7PESXJpCTlmTbJ9gmzLNr89O+DLftQSpJopv5PTXv AFsmj9Zn4lrYTouSiF87DjItnhOWgvRIiP4eoGsMPcJKzBHQcBnqohrlea3DSrWNDT0N K3M6iT5vIR1Hzu/ZXFpZbI6JyRcfH1g5olVTefSNl3643VBWnyLv8+QgF0RxIfEaboFX JIJ8zCLpiDh57sTHOpjc2bIyqUBfKnpRd5vbQWehrazDAAzErBAiGlpwAZI5oPxCbkbp 3B35BYPwEhf2vL6Xxv2a2QHvAztl4jkmn3tGBgnIhcTYIo9y2mXEb/zZBAs2PQADGqTo aytw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=ulRhUBB/501Y6zLj3F+koUiiEJffcO52ksrV1+fMBQw=; b=ljbYRq1qrJyCBgSIH0Kxs2kApTA2StjQhx3CyelrSIjrRNDxGq7miRmydSmK84cn/z g5r0Easi/4dHrjByjE3ncLBCjfvqZU5OkxywXLTejxsvBrMyt58i3wFZqmF2vl3uDIOU kzunP1MIxCmsdmW/yf7YjDCeVa/slmSqq8jni8wQM0/3L5Id7pb8zSPRLDgxQVdPvtsS ka1F27/KhAimti6A+5O1y2oCBhPgjuKwQi0p3ipRLXr6x4Mebrq1sE9ugTSrCMAM5pmQ XZr3PMetblj6J22Z+43eyiF1rn40eS/BvIKG97geQihkc7tdkkvqYBp4qDpm+se0JCM5 eaXg== X-Gm-Message-State: AOAM530LnTPA+KEp664LjD5tatOzlx98t9EVcoc7jscBboM+g/U3ybVI dZpiwkF1uvR6YzrniXjGC2e4ulWgCszGaw== X-Google-Smtp-Source: ABdhPJwVqooJONDPaNYNY2ZHmDu9fgfuBPw9KDbNO3FWyYXRlPMgiXe7aBojp23SFgXVhoWT3boz8A== X-Received: by 2002:a65:6a4a:0:b0:380:fd52:1677 with SMTP id o10-20020a656a4a000000b00380fd521677mr9119180pgu.597.1648450254591; Sun, 27 Mar 2022 23:50:54 -0700 (PDT) Received: from ubuntu.mate (subs09a-223-255-225-67.three.co.id. [223.255.225.67]) by smtp.gmail.com with ESMTPSA id il7-20020a17090b164700b001c779d50699sm17653551pjb.55.2022.03.27.23.50.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 27 Mar 2022 23:50:54 -0700 (PDT) From: Bagas Sanjaya To: linux-doc@vger.kernel.org Cc: Bagas Sanjaya , Jonathan Corbet , "David S. Miller" , Greg Kroah-Hartman , Tony Nguyen , Vinod Koul , Daniel Borkmann , Mauro Carvalho Chehab , Akira Yokosawa , "Rafael J. Wysocki" , Jens Axboe , linux-kernel@vger.kernel.org Subject: [PATCH v3 1/2] Documentation: kernel-doc: Promote two chapter headings to page title Date: Mon, 28 Mar 2022 13:50:30 +0700 Message-Id: <20220328065030.24936-2-bagasdotme@gmail.com> X-Mailer: git-send-email 2.35.1 In-Reply-To: <20220328065030.24936-1-bagasdotme@gmail.com> References: <20220328065030.24936-1-bagasdotme@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" Promote two chapter headings, named "Writing kernel-doc comments" and "Including kernel-doc comments" to page title. These titles deserve their own chapters in PDF output, although these will also appear as two separate titles in table of contents in HTML output. Cc: Jonathan Corbet Cc: "David S. Miller" Cc: Greg Kroah-Hartman Cc: Tony Nguyen Cc: Vinod Koul Cc: Daniel Borkmann Cc: Mauro Carvalho Chehab Cc: Akira Yokosawa Cc: "Rafael J. Wysocki" Cc: Jens Axboe Cc: linux-kernel@vger.kernel.org Suggested-by: Akira Yokosawa Signed-off-by: Bagas Sanjaya --- Documentation/doc-guide/kernel-doc.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-gui= de/kernel-doc.rst index 79aaa55d6bcf2b..a7cb2afd799007 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -1,3 +1,4 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D Writing kernel-doc comments =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D =20 @@ -436,6 +437,7 @@ The title following ``DOC:`` acts as a heading within t= he source file, but also as an identifier for extracting the documentation comment. Thus, the title= must be unique within the file. =20 +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D Including kernel-doc comments =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D =20 --=20 An old man doll... just what I always wanted! - Clara From nobody Tue Jun 23 13:16:27 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id ADF40C433EF for ; Mon, 28 Mar 2022 06:51:13 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238610AbiC1Gwv (ORCPT ); Mon, 28 Mar 2022 02:52:51 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36882 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S238572AbiC1Gwj (ORCPT ); Mon, 28 Mar 2022 02:52:39 -0400 Received: from mail-pj1-x1030.google.com (mail-pj1-x1030.google.com [IPv6:2607:f8b0:4864:20::1030]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B673C4F9EB; Sun, 27 Mar 2022 23:50:59 -0700 (PDT) Received: by mail-pj1-x1030.google.com with SMTP id gb19so13127446pjb.1; Sun, 27 Mar 2022 23:50:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=QdM4cL37RSuglpJuskBFKNTuLb+4KsQrXFdLYdudj7c=; b=piModocVnb2Lvf2pSrRSaV9PrBYf2Voogc+/VCKAZ6OwzdK2+xV6hG1P8kZZyt+GAg 7OOxSJfpt5KR0vGLTsjRpL25RCi8s/BvJ9hYE9FRtQWQcZfyxgHnoWuK97cgljKMtc0c oRF2bgiSYATQFfyEhbGpkqyVeSTl6m2laLE5ZUYS0mvwPWz3Msp1so0a5VHTET8sleYa 3Nk16NXiQ2EwqkONUKGF5xCV+ibb/bQbicC2oZnm/exLnb8PoxSOig/fs+4UaxNhU0LR 7IzkQzuCH8Ewto9rvYR+Ka+rYbxgX0XQ4gU1m/iBlqgQOZjhRnMBOM2NoQRrGy3vkXbS CNiQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=QdM4cL37RSuglpJuskBFKNTuLb+4KsQrXFdLYdudj7c=; b=j0m6G8PpK2ZR8R3/LJV3c2AGPyHQZjwxaj0Cm5HG3BcCOhXtCkFZgRarQtMvldkHhw +xl7PvZRZO/s8tSs0b1++r3lJRm8F/1kpAfiWrm8hDY/RIzyA2IGLeDrveRcALBRpMC5 FAgD2/jRuldzCQCfXRtY6X+fLR3Z+TCQV/tzD2D661jOrZ2Gl6JcX4ih94+p/I5Dltkw HLfMDxVDVICPG0ub+qksb43oGPihZ5fC6IT93YpjU20tP8azVTVuiJlGWkutn88cu9Nd 1d4Orn+czCZpWRQeoY8DLX7ztIWnin3yuSHkbYx0+xnU8aaAEaeQji8oHbxQjlObgxid rteA== X-Gm-Message-State: AOAM530hGkTnlu8tLvV+RkeGkSckSOPxdYApFrMN2wArVa8YckPONdQb 03zwkmibcZCJ5Wwo6L9MhsUf5SMYZSW3qA== X-Google-Smtp-Source: ABdhPJzpvgfIblXEmSmwLCWtUn+QQ9KFwLJc0uyKtr8UrJFG6ztiurWo/6XkkYGei/MOfv+MUoZZ0Q== X-Received: by 2002:a17:90a:9f0b:b0:1c6:a876:4157 with SMTP id n11-20020a17090a9f0b00b001c6a8764157mr27399274pjp.173.1648450258881; Sun, 27 Mar 2022 23:50:58 -0700 (PDT) Received: from ubuntu.mate (subs09a-223-255-225-67.three.co.id. [223.255.225.67]) by smtp.gmail.com with ESMTPSA id il7-20020a17090b164700b001c779d50699sm17653551pjb.55.2022.03.27.23.50.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 27 Mar 2022 23:50:58 -0700 (PDT) From: Bagas Sanjaya To: linux-doc@vger.kernel.org Cc: Bagas Sanjaya , Jonathan Corbet , "David S. Miller" , Greg Kroah-Hartman , Tony Nguyen , Vinod Koul , Daniel Borkmann , Mauro Carvalho Chehab , Akira Yokosawa , "Rafael J. Wysocki" , Jens Axboe , linux-kernel@vger.kernel.org Subject: [PATCH v3 2/2] Documentation: sphinx: replace "Introduction" chapter heading with page title Date: Mon, 28 Mar 2022 13:50:31 +0700 Message-Id: <20220328065030.24936-3-bagasdotme@gmail.com> X-Mailer: git-send-email 2.35.1 In-Reply-To: <20220328065030.24936-1-bagasdotme@gmail.com> References: <20220328065030.24936-1-bagasdotme@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" Replace first chapter heading ("Introduction") with page title named "Using Sphinx for kernel documentation". This way, the first-level TOC for doc-guide contains title instead of chapter headings for this page. Cc: Jonathan Corbet Cc: "David S. Miller" Cc: Greg Kroah-Hartman Cc: Tony Nguyen Cc: Vinod Koul Cc: Daniel Borkmann Cc: Mauro Carvalho Chehab Cc: Akira Yokosawa Cc: "Rafael J. Wysocki" Cc: Jens Axboe Cc: linux-kernel@vger.kernel.org Reviewed-by: Mauro Carvalho Chehab Signed-off-by: Bagas Sanjaya --- Documentation/doc-guide/sphinx.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/s= phinx.rst index bb36f18ae9ac3e..2ff1ab4158d48e 100644 --- a/Documentation/doc-guide/sphinx.rst +++ b/Documentation/doc-guide/sphinx.rst @@ -1,7 +1,8 @@ .. _sphinxdoc: =20 -Introduction -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Using Sphinx for kernel documentation +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 The Linux kernel uses `Sphinx`_ to generate pretty documentation from `reStructuredText`_ files under ``Documentation``. To build the documentat= ion in --=20 An old man doll... just what I always wanted! - Clara