LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Rob Herring <robh@kernel.org>
To: Grant Likely <grant.likely@arm.com>
Cc: Stephen Boyd <sboyd@kernel.org>,
	devicetree-spec@vger.kernel.org, devicetree@vger.kernel.org,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	Frank Rowand <frowand.list@gmail.com>,
	Mark Rutland <mark.rutland@arm.com>,
	Geert Uytterhoeven <geert+renesas@glider.be>,
	Linus Walleij <linus.walleij@linaro.org>,
	Thierry Reding <thierry.reding@gmail.com>,
	Mark Brown <broonie@kernel.org>, Shawn Guo <shawnguo@kernel.org>,
	Bjorn Andersson <bjorn.andersson@linaro.org>,
	Arnd Bergmann <arnd@arndb.de>,
	Jonathan Cameron <jic23@kernel.org>
Subject: Re: [RFC PATCH] dt-bindings: add a jsonschema binding example
Date: Mon, 23 Apr 2018 09:38:59 -0500	[thread overview]
Message-ID: <CAL_Jsq+te3o5=X=1n2QHfrLL_MtoiL92_p8jN2=UeFe3L7mmNA@mail.gmail.com> (raw)
In-Reply-To: <63a1c096-7d78-3850-83b7-94c6009e93f0@arm.com>

On Mon, Apr 23, 2018 at 9:01 AM, Grant Likely <grant.likely@arm.com> wrote:
> On 21/04/2018 00:41, Stephen Boyd wrote:
>>
>> Quoting Rob Herring (2018-04-20 11:15:04)
>>>
>>> On Fri, Apr 20, 2018 at 11:47 AM, Stephen Boyd <sboyd@kernel.org> wrote:
>>>>
>>>> Quoting Rob Herring (2018-04-18 15:29:05)
>>>>>
>>>>> diff --git a/Documentation/devicetree/bindings/example-schema.yaml
>>>>> b/Documentation/devicetree/bindings/example-schema.yaml
>>>>> new file mode 100644
>>>>> index 000000000000..fe0a3bd1668e
>>>>> --- /dev/null
>>>>> +++ b/Documentation/devicetree/bindings/example-schema.yaml
>
> [...]
>>>>>
>>>>> +  interrupts:
>>>>> +    # Either 1 or 2 interrupts can be present
>>>>> +    minItems: 1
>>>>> +    maxItems: 2
>>>>> +    items:
>>>>> +      - description: tx or combined interrupt
>>>>> +      - description: rx interrupt
>>>>> +
>>>>> +    description: |
>>>>
>>>>
>>>> The '|' is needed to make yaml happy?
>>>
>>>
>>> Yes, this is simply how you do literal text blocks in yaml.
>>>
>>> We don't really need for this one really, but for the top-level
>>> 'description' we do. The long term intent is 'description' would be
>>> written in sphinx/rst and can be extracted into the DT spec (for
>>> common bindings). Grant has experimented with that some.
>>
>>
>> Ok. That sounds cool. Then we could embed links to datasheets and SVGs
>> too.
>
>
> I'd like it if we can define the description text blocks to be
> reStructeredText markup. That makes it even easier to integrate with the
> specification documentation.

I think that's going to require thinking about how each binding is
integrated into the spec. We're only talking about common bindings I
presume, but still we have no model defined. For example, with
properties, I'd assume we'd want to generate a table of properties and
we wouldn't want the property descriptions in rST because the
description becomes just a cell in the table. So we need some sort of
template.

Also, how do we validate that description contains valid rST? No point
requiring it until we can validate it.

> [...]
>>>>>
>>>>> +  # Property names starting with '#' must be quoted
>>>>> +  '#interrupt-cells':
>>>>> +    # A simple case where the value must always be '2'.
>>>>> +    # The core schema handles that this must be a single integer.
>>>>> +    const: 2
>>>>> +
>>>>> +  interrupt-controller: {}
>>>>
>>>>
>>>> Does '{}' mean nothing to see here?
>>>
>>>
>>> Yes. It's just an empty schema that's always valid.
>
>
> IIRC, in the current jsonschema draft-6 spec, the following also has the
> same behaviour, which I like slightly better:
>     interrupt-controller: true

They are not exactly the same. '{}' is a schema object and 'true' is
just a boolean. But yes, it can work. We need to drop "type: object"
from meta-schemas/boolean.yaml and it will work.

Rob

  reply	other threads:[~2018-04-23 14:39 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-04-18 22:29 Rob Herring
2018-04-20 16:47 ` Stephen Boyd
2018-04-20 18:15   ` Rob Herring
2018-04-20 19:53     ` Frank Rowand
2018-04-20 23:41     ` Stephen Boyd
2018-04-21  1:34       ` Rob Herring
2018-04-23 14:01       ` Grant Likely
2018-04-23 14:38         ` Rob Herring [this message]
2018-04-23 14:49           ` Grant Likely
2018-04-20 16:59 ` Mark Brown
2018-04-20 18:47   ` Rob Herring
2018-04-20 21:00 ` Frank Rowand
2018-04-21  1:28   ` Rob Herring
2018-04-23  7:25     ` Geert Uytterhoeven
2018-04-23 14:47     ` Grant Likely
2018-04-23 16:49       ` Geert Uytterhoeven
2018-04-25 10:15         ` Grant Likely
2018-04-25  0:33     ` Frank Rowand
2018-11-14 19:39     ` jonsmirl
2018-11-15 23:42       ` Rob Herring
2018-11-16  1:34         ` jonsmirl
2018-04-20 21:47 ` Bjorn Andersson
2018-04-23 16:51   ` Rob Herring

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='CAL_Jsq+te3o5=X=1n2QHfrLL_MtoiL92_p8jN2=UeFe3L7mmNA@mail.gmail.com' \
    --to=robh@kernel.org \
    --cc=arnd@arndb.de \
    --cc=bjorn.andersson@linaro.org \
    --cc=broonie@kernel.org \
    --cc=devicetree-spec@vger.kernel.org \
    --cc=devicetree@vger.kernel.org \
    --cc=frowand.list@gmail.com \
    --cc=geert+renesas@glider.be \
    --cc=grant.likely@arm.com \
    --cc=jic23@kernel.org \
    --cc=linus.walleij@linaro.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=sboyd@kernel.org \
    --cc=shawnguo@kernel.org \
    --cc=thierry.reding@gmail.com \
    --subject='Re: [RFC PATCH] dt-bindings: add a jsonschema binding example' \
    /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

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).