| Message ID | 20230516001518.14514-1-rdunlap@infradead.org |
|---|---|
| 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 b10csp69850vqo;
Mon, 15 May 2023 17:24:36 -0700 (PDT)
X-Google-Smtp-Source:
ACHHUZ4zm5bPy2BIoV5jvAYEanqY504JTXw/DCwlYPRuqk3cmFgqQk54gV9e4lGvhtTN67ulsCCJ
X-Received: by 2002:a05:6a20:8e06:b0:101:5192:18a9 with SMTP id
y6-20020a056a208e0600b00101519218a9mr34684127pzj.21.1684196676569;
Mon, 15 May 2023 17:24:36 -0700 (PDT)
ARC-Seal: i=1; a=rsa-sha256; t=1684196676; cv=none;
d=google.com; s=arc-20160816;
b=qAg9LCgEbFmOjNjLVSck405ZvWzpfvT+HcjR4Ar+L35cOx/dXsXzmN7TAzCQfIK5O+
e4OCac4D4CkP0DJhvyNZJN3BbDEawobh554gaG/7wqZ26671Nyraa2hhPS7bWFJJjR+w
wB/bzJpaXN4f7QR4/jO0bm8khyc8rnh0IrURkff1i1sd/Sria/EERQWXTnMkEQ33mp3e
B9it134bbGySZGc07lzQke4FQx6qTwu59kDegKa24+n8bTI7Z0bPy1dFZrbDc2PHlili
FOLBLPuEFV7JKF5yBRN2UFjpvOCS+erPzlEIhgtcHLXCoDP4cxdbJbQyc36DM2Woenzr
vnQA==
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=Hp8eNJ4FGKpWjH7/UXa5lxTHZ0gnhe4kAwB7/wEPm3k=;
b=0OJoArsvSxErHCEPspct/hPGdMWlB1SUsZq6eCZgkGt5/jnEwEZZ0nx/ux30SrGTA4
xWGiZbb6aU2eajZn96sioVfO/K3NR0EGYWobq53eZnSEEwg5mt5ha4QIBP48cFLdkWmE
2HR9YS3mj1NGVe4Pb3OK7sPTZbhsztZzZtkOZOssChL/YhwPOccJJngDE7RfIJxJYaV3
sYjfeuGJG9Th3gsA1vAv63dCKYrGs2DSbsjHbAIfYrrwFhhOvX+cee3VLKO+T5rQGLgN
6j/ljAMnfhq1ETKFp8oJWP/pot7lDoHxfeDvIPijibpFGsaLRKz9PuTkxZBGfgmjJ1HD
0Vbw==
ARC-Authentication-Results: i=1; mx.google.com;
dkim=pass header.i=@infradead.org header.s=bombadil.20210309
header.b=21bRxEKj;
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
x27-20020aa78f1b000000b0064697515ef6si17940477pfr.361.2023.05.15.17.24.19;
Mon, 15 May 2023 17:24:36 -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;
dkim=pass header.i=@infradead.org header.s=bombadil.20210309
header.b=21bRxEKj;
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 S245192AbjEPAP3 (ORCPT <rfc822;peekingduck44@gmail.com>
+ 99 others); Mon, 15 May 2023 20:15:29 -0400
Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50188 "EHLO
lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org
with ESMTP id S244409AbjEPAPZ (ORCPT
<rfc822;linux-kernel@vger.kernel.org>);
Mon, 15 May 2023 20:15:25 -0400
Received: from bombadil.infradead.org (bombadil.infradead.org
[IPv6:2607:7c80:54:3::133])
by lindbergh.monkeyblade.net (Postfix) with ESMTPS id EFDC183CC;
Mon, 15 May 2023 17:15:22 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed;
d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding:
MIME-Version:Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type:
Content-ID:Content-Description:In-Reply-To:References;
bh=Hp8eNJ4FGKpWjH7/UXa5lxTHZ0gnhe4kAwB7/wEPm3k=;
b=21bRxEKjid143LSrPJ9KQJmOHT
TtiIYJjliwAW+K4n9rjMulnnBtYWP/OuxipzIldGbEkdezOK5fDLTOu+FHpF/2dO9QrWhR3DW5yBT
0OR6ek7mZwtgChabZAnl2oyMmHOxF05TSKvuAe6VyHfAXNK2PV21MZ9uxu8kxIRN1ZsQSKqBbYS3k
BDJB0l5jAMYDxd+TL2gXb9ipIAm+2ekYSySC24Y0wO3ziqbev7jXdsstoaHwkgPf8mME6e/XF0o4l
I+wULKdlTZ64Jds88Ww2/JL+zuW8paR2xCrybFwUkyBK6ZE2TjyZtPu6T5Hpt6uWVXR6iWJLPEaZK
3zQ7qn3w==;
Received: from [2601:1c2:980:9ec0::2764] (helo=bombadil.infradead.org)
by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux))
id 1pyiLX-003vHf-1b;
Tue, 16 May 2023 00:15:19 +0000
From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org,
linux-fpga@vger.kernel.org, Phillip Potter <phil@philpotter.co.uk>,
Moritz Fischer <mdf@kernel.org>, Wu Hao <hao.wu@intel.com>,
Xu Yilun <yilun.xu@intel.com>, Tom Rix <trix@redhat.com>,
Peter Zijlstra <peterz@infradead.org>,
Ingo Molnar <mingo@redhat.com>, Will Deacon <will@kernel.org>,
Waiman Long <longman@redhat.com>,
Boqun Feng <boqun.feng@gmail.com>,
Dominik Brodowski <linux@dominikbrodowski.net>,
Thomas Gleixner <tglx@linutronix.de>
Subject: [PATCH] Documentation: use capitalization for chapters and acronyms
Date: Mon, 15 May 2023 17:15:18 -0700
Message-Id: <20230516001518.14514-1-rdunlap@infradead.org>
X-Mailer: git-send-email 2.40.1
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
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,T_SCC_BODY_TEXT_LINE,URIBL_BLOCKED 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: <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?1766008213888944409?=
X-GMAIL-MSGID: =?utf-8?q?1766008213888944409?=
|
| Series |
Documentation: use capitalization for chapters and acronyms
|
|
Commit Message
Randy Dunlap
May 16, 2023, 12:15 a.m. UTC
Use capital letters in acronyms for CD-ROM, FPGA, and PCMCIA.
Use capital letter in the first word of chapter headings for
Locking, Timers, and "Brief tutorial on CRC computation".
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: linux-fpga@vger.kernel.org
Cc: Phillip Potter <phil@philpotter.co.uk>
Cc: Moritz Fischer <mdf@kernel.org>
Cc: Wu Hao <hao.wu@intel.com>
Cc: Xu Yilun <yilun.xu@intel.com>
Cc: Tom Rix <trix@redhat.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Will Deacon <will@kernel.org>
Cc: Waiman Long <longman@redhat.com>
Cc: Boqun Feng <boqun.feng@gmail.com>
Cc: Dominik Brodowski <linux@dominikbrodowski.net>
Cc: Thomas Gleixner <tglx@linutronix.de>
---
Documentation/cdrom/index.rst | 6 +++---
Documentation/fpga/index.rst | 2 +-
Documentation/locking/index.rst | 2 +-
Documentation/pcmcia/index.rst | 2 +-
Documentation/staging/crc32.rst | 2 +-
Documentation/timers/index.rst | 2 +-
6 files changed, 8 insertions(+), 8 deletions(-)
Comments
On Mon, May 15, 2023 at 05:15:18PM -0700, Randy Dunlap wrote: > Use capital letters in acronyms for CD-ROM, FPGA, and PCMCIA. > > Use capital letter in the first word of chapter headings for > Locking, Timers, and "Brief tutorial on CRC computation". > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: Jonathan Corbet <corbet@lwn.net> > Cc: linux-doc@vger.kernel.org > Cc: linux-fpga@vger.kernel.org > Cc: Phillip Potter <phil@philpotter.co.uk> > Cc: Moritz Fischer <mdf@kernel.org> > Cc: Wu Hao <hao.wu@intel.com> > Cc: Xu Yilun <yilun.xu@intel.com> > Cc: Tom Rix <trix@redhat.com> > Cc: Peter Zijlstra <peterz@infradead.org> > Cc: Ingo Molnar <mingo@redhat.com> > Cc: Will Deacon <will@kernel.org> > Cc: Waiman Long <longman@redhat.com> > Cc: Boqun Feng <boqun.feng@gmail.com> > Cc: Dominik Brodowski <linux@dominikbrodowski.net> > Cc: Thomas Gleixner <tglx@linutronix.de> > --- > Documentation/cdrom/index.rst | 6 +++--- > Documentation/fpga/index.rst | 2 +- > Documentation/locking/index.rst | 2 +- > Documentation/pcmcia/index.rst | 2 +- > Documentation/staging/crc32.rst | 2 +- > Documentation/timers/index.rst | 2 +- > 6 files changed, 8 insertions(+), 8 deletions(-) > > --- linux-next-20230515.orig/Documentation/cdrom/index.rst > +++ linux-next-20230515/Documentation/cdrom/index.rst > @@ -1,8 +1,8 @@ > .. SPDX-License-Identifier: GPL-2.0 > > -===== > -cdrom > -===== > +====== > +CD-ROM > +====== > > .. toctree:: > :maxdepth: 1 > --- linux-next-20230515.orig/Documentation/fpga/index.rst > +++ linux-next-20230515/Documentation/fpga/index.rst > @@ -1,7 +1,7 @@ > .. SPDX-License-Identifier: GPL-2.0 > > ==== > -fpga > +FPGA > ==== > > .. toctree:: > --- linux-next-20230515.orig/Documentation/locking/index.rst > +++ linux-next-20230515/Documentation/locking/index.rst > @@ -1,7 +1,7 @@ > .. SPDX-License-Identifier: GPL-2.0 > > ======= > -locking > +Locking > ======= > > .. toctree:: > --- linux-next-20230515.orig/Documentation/pcmcia/index.rst > +++ linux-next-20230515/Documentation/pcmcia/index.rst > @@ -1,7 +1,7 @@ > .. SPDX-License-Identifier: GPL-2.0 > > ====== > -pcmcia > +PCMCIA > ====== > > .. toctree:: > --- linux-next-20230515.orig/Documentation/staging/crc32.rst > +++ linux-next-20230515/Documentation/staging/crc32.rst > @@ -1,5 +1,5 @@ > ================================= > -brief tutorial on CRC computation > +Brief tutorial on CRC computation > ================================= > > A CRC is a long-division remainder. You add the CRC to the message, > --- linux-next-20230515.orig/Documentation/timers/index.rst > +++ linux-next-20230515/Documentation/timers/index.rst > @@ -1,7 +1,7 @@ > .. SPDX-License-Identifier: GPL-2.0 > > ====== > -timers > +Timers > ====== > > .. toctree:: Hi Randy, Thanks for the patch. Reviewed-by: Phillip Potter <phil@philpotter.co.uk> Regards, Phil
On 2023-05-15 at 17:15:18 -0700, Randy Dunlap wrote: > Use capital letters in acronyms for CD-ROM, FPGA, and PCMCIA. > > Use capital letter in the first word of chapter headings for > Locking, Timers, and "Brief tutorial on CRC computation". > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: Jonathan Corbet <corbet@lwn.net> > Cc: linux-doc@vger.kernel.org > Cc: linux-fpga@vger.kernel.org > Cc: Phillip Potter <phil@philpotter.co.uk> > Cc: Moritz Fischer <mdf@kernel.org> > Cc: Wu Hao <hao.wu@intel.com> > Cc: Xu Yilun <yilun.xu@intel.com> > Cc: Tom Rix <trix@redhat.com> > Cc: Peter Zijlstra <peterz@infradead.org> > Cc: Ingo Molnar <mingo@redhat.com> > Cc: Will Deacon <will@kernel.org> > Cc: Waiman Long <longman@redhat.com> > Cc: Boqun Feng <boqun.feng@gmail.com> > Cc: Dominik Brodowski <linux@dominikbrodowski.net> > Cc: Thomas Gleixner <tglx@linutronix.de> > --- > Documentation/cdrom/index.rst | 6 +++--- > Documentation/fpga/index.rst | 2 +- > Documentation/locking/index.rst | 2 +- > Documentation/pcmcia/index.rst | 2 +- > Documentation/staging/crc32.rst | 2 +- > Documentation/timers/index.rst | 2 +- > 6 files changed, 8 insertions(+), 8 deletions(-) > > --- linux-next-20230515.orig/Documentation/cdrom/index.rst > +++ linux-next-20230515/Documentation/cdrom/index.rst > @@ -1,8 +1,8 @@ > .. SPDX-License-Identifier: GPL-2.0 > > -===== > -cdrom > -===== > +====== > +CD-ROM > +====== > > .. toctree:: > :maxdepth: 1 > --- linux-next-20230515.orig/Documentation/fpga/index.rst > +++ linux-next-20230515/Documentation/fpga/index.rst > @@ -1,7 +1,7 @@ > .. SPDX-License-Identifier: GPL-2.0 > > ==== > -fpga > +FPGA > ==== For FPGA part, Acked-by: Xu Yilun <yilun.xu@intel.com> Thanks
Randy Dunlap <rdunlap@infradead.org> writes: > Use capital letters in acronyms for CD-ROM, FPGA, and PCMCIA. > > Use capital letter in the first word of chapter headings for > Locking, Timers, and "Brief tutorial on CRC computation". > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: Jonathan Corbet <corbet@lwn.net> > Cc: linux-doc@vger.kernel.org > Cc: linux-fpga@vger.kernel.org > Cc: Phillip Potter <phil@philpotter.co.uk> > Cc: Moritz Fischer <mdf@kernel.org> > Cc: Wu Hao <hao.wu@intel.com> > Cc: Xu Yilun <yilun.xu@intel.com> > Cc: Tom Rix <trix@redhat.com> > Cc: Peter Zijlstra <peterz@infradead.org> > Cc: Ingo Molnar <mingo@redhat.com> > Cc: Will Deacon <will@kernel.org> > Cc: Waiman Long <longman@redhat.com> > Cc: Boqun Feng <boqun.feng@gmail.com> > Cc: Dominik Brodowski <linux@dominikbrodowski.net> > Cc: Thomas Gleixner <tglx@linutronix.de> > --- > Documentation/cdrom/index.rst | 6 +++--- > Documentation/fpga/index.rst | 2 +- > Documentation/locking/index.rst | 2 +- > Documentation/pcmcia/index.rst | 2 +- > Documentation/staging/crc32.rst | 2 +- > Documentation/timers/index.rst | 2 +- > 6 files changed, 8 insertions(+), 8 deletions(-) Applied, thanks. jon
--- linux-next-20230515.orig/Documentation/cdrom/index.rst +++ linux-next-20230515/Documentation/cdrom/index.rst @@ -1,8 +1,8 @@ .. SPDX-License-Identifier: GPL-2.0 -===== -cdrom -===== +====== +CD-ROM +====== .. toctree:: :maxdepth: 1 --- linux-next-20230515.orig/Documentation/fpga/index.rst +++ linux-next-20230515/Documentation/fpga/index.rst @@ -1,7 +1,7 @@ .. SPDX-License-Identifier: GPL-2.0 ==== -fpga +FPGA ==== .. toctree:: --- linux-next-20230515.orig/Documentation/locking/index.rst +++ linux-next-20230515/Documentation/locking/index.rst @@ -1,7 +1,7 @@ .. SPDX-License-Identifier: GPL-2.0 ======= -locking +Locking ======= .. toctree:: --- linux-next-20230515.orig/Documentation/pcmcia/index.rst +++ linux-next-20230515/Documentation/pcmcia/index.rst @@ -1,7 +1,7 @@ .. SPDX-License-Identifier: GPL-2.0 ====== -pcmcia +PCMCIA ====== .. toctree:: --- linux-next-20230515.orig/Documentation/staging/crc32.rst +++ linux-next-20230515/Documentation/staging/crc32.rst @@ -1,5 +1,5 @@ ================================= -brief tutorial on CRC computation +Brief tutorial on CRC computation ================================= A CRC is a long-division remainder. You add the CRC to the message, --- linux-next-20230515.orig/Documentation/timers/index.rst +++ linux-next-20230515/Documentation/timers/index.rst @@ -1,7 +1,7 @@ .. SPDX-License-Identifier: GPL-2.0 ====== -timers +Timers ====== .. toctree::