devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Conor Dooley <conor@kernel.org>
To: "Rob Herring (Arm)" <robh@kernel.org>
Cc: Krzysztof Kozlowski <krzk+dt@kernel.org>,
	Conor Dooley <conor+dt@kernel.org>,
	devicetree@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [RFC PATCH] dt-bindings: writing-schema: Add details on YAML text blocks
Date: Thu, 19 Sep 2024 08:37:14 +0100	[thread overview]
Message-ID: <20240919-bluff-thievish-9be0cdb5df9d@squawk> (raw)
In-Reply-To: <20240918195130.2024205-2-robh@kernel.org>

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

On Wed, Sep 18, 2024 at 02:51:30PM -0500, Rob Herring (Arm) wrote:
> The YAML format has a couple of different forms for multi-line text
> blocks which control allowed characters and handling of line-breaks.
> Getting this wrong is a common review issue. Either a literal block is
> used when there's no formatting needed or a folded/literal block is
> not used when there is formatting to maintain.
> 
> Add some descriptions of the different forms to point folks to in
> reviews.

And mentioning the # stuff is good too, keep hitting that with the
commit descriptions in the riscv extension stuff. That said, not as if
people read documentation anyway...

Reviewed-by: Conor Dooley <conor.dooley@microchip.com>

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

  reply	other threads:[~2024-09-19  7:37 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-09-18 19:51 [RFC PATCH] dt-bindings: writing-schema: Add details on YAML text blocks Rob Herring (Arm)
2024-09-19  7:37 ` Conor Dooley [this message]
2024-09-25  7:56 ` Krzysztof Kozlowski

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=20240919-bluff-thievish-9be0cdb5df9d@squawk \
    --to=conor@kernel.org \
    --cc=conor+dt@kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=krzk+dt@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=robh@kernel.org \
    /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;
as well as URLs for NNTP newsgroup(s).