Linux Documentation
 help / color / mirror / Atom feed
From: Conor Dooley <conor.dooley@microchip.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Conor Dooley <conor@kernel.org>,
	Alexandre Ghiti <alexghiti@rivosinc.com>,
	Atish Kumar Patra <atishp@rivosinc.com>,
	Paul Walmsley <paul.walmsley@sifive.com>,
	Palmer Dabbelt <palmer@dabbelt.com>,
	Albert Ou <aou@eecs.berkeley.edu>, <linux-doc@vger.kernel.org>,
	<linux-riscv@lists.infradead.org>, <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH 1/2] Documentation: riscv: Add early boot document
Date: Tue, 20 Jun 2023 10:57:20 +0100	[thread overview]
Message-ID: <20230620-slot-bobtail-4f41b59f4cf9@wendy> (raw)
In-Reply-To: <87r0q7v1o9.fsf@meer.lwn.net>

[-- Attachment #1: Type: text/plain, Size: 1650 bytes --]

On Mon, Jun 19, 2023 at 10:48:06AM -0600, Jonathan Corbet wrote:
> Conor Dooley <conor@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@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.

Okay, thanks.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

  reply	other threads:[~2023-06-20 10:00 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-06-19  9:47 [PATCH 1/2] Documentation: riscv: Add early boot document Alexandre Ghiti
2023-06-19  9:47 ` [PATCH 2/2] Documentation: riscv: Update boot image header since EFI stub is supported Alexandre Ghiti
2023-06-19 18:58   ` Atish Patra
2023-06-19  9:49 ` [PATCH 1/2] Documentation: riscv: Add early boot document Alexandre Ghiti
2023-06-20  7:18   ` Sunil V L
2023-06-20  8:14     ` Alexandre Ghiti
2023-06-19 11:00 ` Björn Töpel
2023-06-19 12:25 ` Conor Dooley
2023-06-19 14:04   ` Alexandre Ghiti
2023-06-19 16:00     ` Conor Dooley
2023-06-19 16:48       ` Jonathan Corbet
2023-06-20  9:57         ` Conor Dooley [this message]
2023-06-20  9:09       ` Alexandre Ghiti
2023-06-20 10:33         ` Conor Dooley
2023-06-20 12:00           ` Alexandre Ghiti
2023-06-20  7:41     ` Sunil V L
2023-06-20  8:24       ` Alexandre Ghiti
2023-06-20 10:31 ` Song Shuai
2023-06-20 12:06   ` Alexandre Ghiti

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230620-slot-bobtail-4f41b59f4cf9@wendy \
    --to=conor.dooley@microchip.com \
    --cc=alexghiti@rivosinc.com \
    --cc=aou@eecs.berkeley.edu \
    --cc=atishp@rivosinc.com \
    --cc=conor@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-riscv@lists.infradead.org \
    --cc=palmer@dabbelt.com \
    --cc=paul.walmsley@sifive.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox