From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
To: David Heidelberg <david@ixit.cz>, bjorn.andersson@linaro.org
Cc: devicetree@vger.kernel.org
Subject: Re: Multiline in device-trees bindings
Date: Sun, 24 Apr 2022 12:44:06 +0200 [thread overview]
Message-ID: <8a343b5c-1d3e-2c1d-da6a-c9b1cac89ec4@linaro.org> (raw)
In-Reply-To: <c652c8cb-23ba-c5e4-cebe-383a9237d798@ixit.cz>
On 24/04/2022 10:34, David Heidelberg wrote:
> Hi.
>
> Often is suggested to drop `|` and `>` for the `description` inside
> device-tree bindings.
>
> I haven't found any recommendation related to the device-tree bindings,
> but from [1] it seems to be even used in example.
>
> My main concern would be, that using block style indicators [2] can make
> text more readable in future, when at some point eye pleasing
> documentation gets generated from the device-tree YAML files.
I understand it is about usage of '|' or '>' against nothing marked at
all. In such case I don't see the benefit of using block markers for
cases when they are not needed, because they produce exactly the same
output as one without them. Where is the "more readable"?
It's entirely different of course for text which benefits from block
markers, but no one recommended you to drop block markers in such case,
right?
>
> Would be nice to have consensus when to use them and when not to. Maybe
> add it into documentation or reference YAML documentation with addition
> of specific recommendation for the kernel project?
I think the consensus is already there - when using block markers is
equal to not using them, why adding block markers?
Best regards,
Krzysztof
prev parent reply other threads:[~2022-04-24 10:44 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-24 8:34 Multiline in device-trees bindings David Heidelberg
2022-04-24 10:44 ` Krzysztof Kozlowski [this message]
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=8a343b5c-1d3e-2c1d-da6a-c9b1cac89ec4@linaro.org \
--to=krzysztof.kozlowski@linaro.org \
--cc=bjorn.andersson@linaro.org \
--cc=david@ixit.cz \
--cc=devicetree@vger.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).