linux-kernel - [PATCH] Documentation: use capitalization for chapters and acronyms

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20230516001518.14514-1-rdunlap@infradead.org>
Date:   Mon, 15 May 2023 17:15:18 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     linux-kernel@...r.kernel.org
Cc:     Randy Dunlap <rdunlap@...radead.org>,
        Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org,
        linux-fpga@...r.kernel.org, Phillip Potter <phil@...lpotter.co.uk>,
        Moritz Fischer <mdf@...nel.org>, Wu Hao <hao.wu@...el.com>,
        Xu Yilun <yilun.xu@...el.com>, Tom Rix <trix@...hat.com>,
        Peter Zijlstra <peterz@...radead.org>,
        Ingo Molnar <mingo@...hat.com>, Will Deacon <will@...nel.org>,
        Waiman Long <longman@...hat.com>,
        Boqun Feng <boqun.feng@...il.com>,
        Dominik Brodowski <linux@...inikbrodowski.net>,
        Thomas Gleixner <tglx@...utronix.de>
Subject: [PATCH] Documentation: use capitalization for chapters and acronyms

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@...radead.org>
Cc: Jonathan Corbet <corbet@....net>
Cc: linux-doc@...r.kernel.org
Cc: linux-fpga@...r.kernel.org
Cc: Phillip Potter <phil@...lpotter.co.uk>
Cc: Moritz Fischer <mdf@...nel.org>
Cc: Wu Hao <hao.wu@...el.com>
Cc: Xu Yilun <yilun.xu@...el.com>
Cc: Tom Rix <trix@...hat.com>
Cc: Peter Zijlstra <peterz@...radead.org>
Cc: Ingo Molnar <mingo@...hat.com>
Cc: Will Deacon <will@...nel.org>
Cc: Waiman Long <longman@...hat.com>
Cc: Boqun Feng <boqun.feng@...il.com>
Cc: Dominik Brodowski <linux@...inikbrodowski.net>
Cc: Thomas Gleixner <tglx@...utronix.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::