On 23/04/2018 15:38, Rob Herring wrote:
On Mon, Apr 23, 2018 at 9:01 AM, Grant Likely <grant.likely@xxxxxxx> 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@xxxxxxxxxx> 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.
Indeed. Part of that was me thinking outloud. Need to actually get it
working before adding constraints.
g.
IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you.
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
