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

[Phillip Potter]

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@xxxxxxxxxxxxx>
> Cc: Jonathan Corbet <corbet@xxxxxxx>
> Cc: linux-doc@xxxxxxxxxxxxxxx
> Cc: linux-fpga@xxxxxxxxxxxxxxx
> Cc: Phillip Potter <phil@xxxxxxxxxxxxxxxx>
> Cc: Moritz Fischer <mdf@xxxxxxxxxx>
> Cc: Wu Hao <hao.wu@xxxxxxxxx>
> Cc: Xu Yilun <yilun.xu@xxxxxxxxx>
> Cc: Tom Rix <trix@xxxxxxxxxx>
> Cc: Peter Zijlstra <peterz@xxxxxxxxxxxxx>
> Cc: Ingo Molnar <mingo@xxxxxxxxxx>
> Cc: Will Deacon <will@xxxxxxxxxx>
> Cc: Waiman Long <longman@xxxxxxxxxx>
> Cc: Boqun Feng <boqun.feng@xxxxxxxxx>
> Cc: Dominik Brodowski <linux@xxxxxxxxxxxxxxxxxxxx>
> Cc: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
> ---
>  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@xxxxxxxxxxxxxxxx>

Regards,
Phil