Message ID | 20230425072644.868535-1-costa.shul@redhat.com |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp3228844vqo; Tue, 25 Apr 2023 00:29:48 -0700 (PDT) X-Google-Smtp-Source: AKy350bAahaU0tIGucRnWQN0TOpHkRN44TQQlgBOYT/cDElg7EmduhBZu6C/6oOx3wa+j/S/pnHw X-Received: by 2002:a17:90b:3e8b:b0:246:c3e1:c931 with SMTP id rj11-20020a17090b3e8b00b00246c3e1c931mr14745449pjb.23.1682407788488; Tue, 25 Apr 2023 00:29:48 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1682407788; cv=none; d=google.com; s=arc-20160816; b=naRKbLqIefgDXJ1qD8O+7HpqaN/srg5dBiqwECvx7vkJjLIuzLShB0f0pfyFz9Y3rm zyb4+wF3VLPj8SjToiJh8IJBozItp/hkJw0o28rOLxoFV+OJIkz941tlqg1+ojZJjW+e FRsYwA9FtlwfX5lEzVQVFY8/BQsemjIETfG+vfEpNIfCJbaCqfyzgSkgfYSL3jL5x9TE lTv8XrDRtlGePjIQomo7e+IZufoXO9UDxOFysi1wLRUjWlPed5wJiTJ+SosT7aUHyO49 HMVArPuabJlSkTfOoAt/Ajh6O40wQZngR3ZVfy7/8o9TcoycRl2kC3wyb0x1km4PFjxG cPMA== 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; bh=anbzC7fpaMxRgKbGTHCf+Ypir7RbEsM4mAuu7bHFScU=; b=crCI0ERhQOqhvAEP2oS9L1cLimbp/PI2TZfpFUljhI6zIhjiEoD1WqWOKbQLWTOwOF NfSQg8ryVyOFfVWQ15n6atxh2WpuBoW0dJ56I6LH7GEvQGaPnGXrAAis5Xx3/UkH5UEJ wTK5k+4/rNMXu9vyuIVZ1OFlSyaq7lqHwWB46slG5mBdoOec4i5bVQCtvBeKbUHv1CMj I52wqgSaSZp9QY4Tigy2oVj4tMrjveNuZZIPZ3StfGzeny/rVA13UPMeT/hM/iFR6Dy4 yuA1sfIYUNErZjAYY+NvJfMU2WepcOXqlDX+ozNMSiCVc5obZaMge9fqt2+nso10YKIx XfEA== ARC-Authentication-Results: i=1; mx.google.com; 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; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=redhat.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id pi12-20020a17090b1e4c00b0024bd4a6e728si2092677pjb.92.2023.04.25.00.29.33; Tue, 25 Apr 2023 00:29:48 -0700 (PDT) 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; 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; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=redhat.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233580AbjDYH2k (ORCPT <rfc822;zxc52fgh@gmail.com> + 99 others); Tue, 25 Apr 2023 03:28:40 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40364 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233620AbjDYH1y (ORCPT <rfc822;linux-kernel@vger.kernel.org>); Tue, 25 Apr 2023 03:27:54 -0400 Received: from mail-wr1-f54.google.com (mail-wr1-f54.google.com [209.85.221.54]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7FF35CC0F; Tue, 25 Apr 2023 00:27:13 -0700 (PDT) Received: by mail-wr1-f54.google.com with SMTP id ffacd0b85a97d-3047ff3269aso997751f8f.0; Tue, 25 Apr 2023 00:27:13 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682407623; x=1684999623; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=anbzC7fpaMxRgKbGTHCf+Ypir7RbEsM4mAuu7bHFScU=; b=bgEl7WVxOhfc7V/EGpfWhH30TEreSYY9q/2hg7fBURjoHiiho7lr79vrO+0HOFsbr9 MMBL97H69YVMQy1gps10Moucx1jEmNljRPX0R5e6dlP2CxaSp/s6sXxC331cz7U6Eqf7 GakaR26Jd+9s5SYuO2/CfqhpyCv6RHqwLqp5XMc4JKr6ZxcXUMRXkETZ6tji3t2a7Lyq 3r21n0FyNAPv1yQd+NpbCCE/w0hvpf3eR6vDHx3XSQMllSrP9fbUUFTgx4xZTi3fMNG/ KzURjzrupc0978suMCqmqeF6hYCyA1/iRLV46AW0vIcBlJTZAFSX7esEfUXcSgKdq75j nhIA== X-Gm-Message-State: AAQBX9cFptGHy+8Q36/gof+ncOA5dXDFd1s7VbD8q7cncI/sorMg6OEy FxRRlK5a+q8o+q/8Nkvt5aQ= X-Received: by 2002:a5d:4c4d:0:b0:2d7:a062:ec8 with SMTP id n13-20020a5d4c4d000000b002d7a0620ec8mr11277270wrt.41.1682407623105; Tue, 25 Apr 2023 00:27:03 -0700 (PDT) Received: from costa-tp.redhat.com ([2a00:a040:1a3:c11b:3ae6:1732:e587:a81f]) by smtp.gmail.com with ESMTPSA id c16-20020a05600c0ad000b003f198dfbbfcsm8411489wmr.19.2023.04.25.00.27.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 25 Apr 2023 00:27:02 -0700 (PDT) From: Costa Shulyupin <costa.shul@redhat.com> To: Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org Cc: Costa Shulyupin <costa.shul@redhat.com>, Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>, Akira Yokosawa <akiyks@gmail.com>, Greg Kroah-Hartman <gregkh@linuxfoundation.org>, Thorsten Leemhuis <linux@leemhuis.info>, Lukas Bulwahn <lukas.bulwahn@gmail.com>, Rong Tao <rtoax@foxmail.com>, linux-kernel@vger.kernel.org (open list) Subject: [PATCH] docs: split subtitle of Submitting patches Date: Tue, 25 Apr 2023 10:26:43 +0300 Message-Id: <20230425072644.868535-1-costa.shul@redhat.com> X-Mailer: git-send-email 2.40.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-1.4 required=5.0 tests=BAYES_00, FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM,HEADER_FROM_DIFFERENT_DOMAINS, RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_PASS, T_SCC_BODY_TEXT_LINE autolearn=no 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: <linux-kernel.vger.kernel.org> X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1764132428784070397?= X-GMAIL-MSGID: =?utf-8?q?1764132428784070397?= |
Series |
docs: split subtitle of Submitting patches
|
|
Commit Message
Costa Shulyupin
April 25, 2023, 7:26 a.m. UTC
Motivation:
The original long page title in the left Content pane spans three lines:
Submitting patches: the essential
guide to getting your code into
the kernel
Issues:
- It is not readable.
- It further inflates already overpopulated Contents pane.
The solution:
- Split the long title to title and subtitle.
- Vertical bar '|' in Sphinx-doc introduces empty line to
make the subtitle closer to the title than to the following text.
Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
---
Documentation/process/submitting-patches.rst | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
Comments
On 4/25/23 14:26, Costa Shulyupin wrote: > Motivation: > > The original long page title in the left Content pane spans three lines: > > Submitting patches: the essential > guide to getting your code into > the kernel > I think it's OK to have that, if the title can't be further condensed. > Issues: > - It is not readable. > - It further inflates already overpopulated Contents pane. > table of contents? > The solution: > - Split the long title to title and subtitle. > - Vertical bar '|' in Sphinx-doc introduces empty line to > make the subtitle closer to the title than to the following text. > Nope. The title (as a whole) is already descriptive enough for describing the text. Thanks.
On 5/30/23 08:20, Bagas Sanjaya wrote: > On 4/25/23 14:26, Costa Shulyupin wrote: >> Motivation: >> >> The original long page title in the left Content pane spans three lines: >> >> Submitting patches: the essential >> guide to getting your code into >> the kernel >> > > I think it's OK to have that, if the title can't be further condensed. > Oops, I mean it's perfectly OK to have long title written as-is if it can't be further condensed to convey the doc theme.
diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst index 7a5619fecb38..051eba1bbc7f 100644 --- a/Documentation/process/submitting-patches.rst +++ b/Documentation/process/submitting-patches.rst @@ -1,7 +1,10 @@ .. _submittingpatches: -Submitting patches: the essential guide to getting your code into the kernel -============================================================================ +Submitting patches +================== +The essential guide to getting your code into the kernel + +| For a person or company who wishes to submit a change to the Linux kernel, the process can sometimes be daunting if you're not familiar