2023-05-16 00:17:16

by Randy Dunlap

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 <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: Phillip Potter <[email protected]>
Cc: Moritz Fischer <[email protected]>
Cc: Wu Hao <[email protected]>
Cc: Xu Yilun <[email protected]>
Cc: Tom Rix <[email protected]>
Cc: Peter Zijlstra <[email protected]>
Cc: Ingo Molnar <[email protected]>
Cc: Will Deacon <[email protected]>
Cc: Waiman Long <[email protected]>
Cc: Boqun Feng <[email protected]>
Cc: Dominik Brodowski <[email protected]>
Cc: Thomas Gleixner <[email protected]>
---
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::

2023-05-16 05:51:15

by Phillip Potter

Subject: Re: [PATCH] Documentation: use capitalization for chapters and acronyms

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 <[email protected]>
> Cc: Jonathan Corbet <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Cc: Phillip Potter <[email protected]>
> Cc: Moritz Fischer <[email protected]>
> Cc: Wu Hao <[email protected]>
> Cc: Xu Yilun <[email protected]>
> Cc: Tom Rix <[email protected]>
> Cc: Peter Zijlstra <[email protected]>
> Cc: Ingo Molnar <[email protected]>
> Cc: Will Deacon <[email protected]>
> Cc: Waiman Long <[email protected]>
> Cc: Boqun Feng <[email protected]>
> Cc: Dominik Brodowski <[email protected]>
> Cc: Thomas Gleixner <[email protected]>
> ---
> 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 <[email protected]>

Regards,
Phil

2023-05-16 06:16:47

by Xu Yilun

Subject: Re: [PATCH] Documentation: use capitalization for chapters and acronyms

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 <[email protected]>
> Cc: Jonathan Corbet <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Cc: Phillip Potter <[email protected]>
> Cc: Moritz Fischer <[email protected]>
> Cc: Wu Hao <[email protected]>
> Cc: Xu Yilun <[email protected]>
> Cc: Tom Rix <[email protected]>
> Cc: Peter Zijlstra <[email protected]>
> Cc: Ingo Molnar <[email protected]>
> Cc: Will Deacon <[email protected]>
> Cc: Waiman Long <[email protected]>
> Cc: Boqun Feng <[email protected]>
> Cc: Dominik Brodowski <[email protected]>
> Cc: Thomas Gleixner <[email protected]>
> ---
> 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 <[email protected]>

Thanks

2023-05-16 19:05:20

by Jonathan Corbet

Subject: Re: [PATCH] Documentation: use capitalization for chapters and acronyms

Randy Dunlap <[email protected]> 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 <[email protected]>
> Cc: Jonathan Corbet <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Cc: Phillip Potter <[email protected]>
> Cc: Moritz Fischer <[email protected]>
> Cc: Wu Hao <[email protected]>
> Cc: Xu Yilun <[email protected]>
> Cc: Tom Rix <[email protected]>
> Cc: Peter Zijlstra <[email protected]>
> Cc: Ingo Molnar <[email protected]>
> Cc: Will Deacon <[email protected]>
> Cc: Waiman Long <[email protected]>
> Cc: Boqun Feng <[email protected]>
> Cc: Dominik Brodowski <[email protected]>
> Cc: Thomas Gleixner <[email protected]>
> ---
> 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