[PATCH 1/2] Documentation: riscv: Add early boot document
Jonathan Corbet
corbet at lwn.net
Mon Jun 19 09:48:06 PDT 2023
Conor Dooley <conor at kernel.org> writes:
> On Mon, Jun 19, 2023 at 04:04:52PM +0200, Alexandre Ghiti wrote:
>> On Mon, Jun 19, 2023 at 2:26 PM Conor Dooley <conor.dooley at microchip.com> wrote:
>> > On Mon, Jun 19, 2023 at 11:47:04AM +0200, Alexandre Ghiti wrote:
>
>> > > diff --git a/Documentation/riscv/boot.rst b/Documentation/riscv/boot.rst
>> > > new file mode 100644
>> > > index 000000000000..b02230818b79
>> > > --- /dev/null
>> > > +++ b/Documentation/riscv/boot.rst
>> > > @@ -0,0 +1,181 @@
>> > > +.. SPDX-License-Identifier: GPL-2.0
>> > > +
>> > > +=============================================
>> > > +Early boot requirements/constraints on RISC-V
>> > > +=============================================
>> >
>> > Please use "title case", here and elsewhere in the doc.
>>
>> You mean using "title: " instead of "===="? Or using uppercase for the
>> first letter of each word? FYI I followed
>> https://docs.kernel.org/doc-guide/sphinx.html?highlight=title#specific-guidelines-for-the-kernel-documentation
>
> The latter. That's weird, I guess it would be nice to see what Jon
> thinks about that.
I have Never Been Fond of Excessive Use of Capital Letters, so my
preference would be capitalization as in a normal sentence.
That said, I don't really feel that something like this is important
enough that we need to define and enforce a policy around it. If the
maintainers for specific subsystems feel differently, then I guess
that's up to them.
Thanks,
jon
More information about the linux-riscv
mailing list