| Message ID | 20230516001518.14514-1-rdunlap@infradead.org (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | Documentation: use capitalization for chapters and acronyms | expand |
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::
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(-)