Add yamllint config and fix all errors

Add configuration for yamllint and fix all the errors/warnings.
The configuration matches what is used in the Linux kernel tree except
single quotes are required and 'check-keys' option is enabled.
'check-keys' depends on a newish version of yamllint, so it hasn't been
enabled in the Linux kernel tree yet.

Signed-off-by: Rob Herring (Arm) <[email protected]>

Author: robherring

.github/workflows/ci.yml

@@ -28,6 +28,9 @@ jobs:
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Lint with yamllint
+      run: |
+        yamllint --strict $(git ls-files '*.yaml')
     - name: Test
       run: |
         test/test-dt-validate.py

.yamllint

@@ -0,0 +1,46 @@
+extends: relaxed
+
+rules:
+  quoted-strings:
+    quote-type: single
+    required: only-when-needed
+    check-keys: true
+    extra-allowed:
+      - '[$^[\\]'
+      - '^/$'
+  line-length:
+    # 80 chars should be enough, but don't fail if a line is longer
+    max: 110
+    allow-non-breakable-words: true
+    level: warning
+  braces:
+    min-spaces-inside: 0
+    max-spaces-inside: 1
+    min-spaces-inside-empty: 0
+    max-spaces-inside-empty: 0
+  brackets:
+    min-spaces-inside: 0
+    max-spaces-inside: 1
+    min-spaces-inside-empty: 0
+    max-spaces-inside-empty: 0
+  colons: {max-spaces-before: 0, max-spaces-after: 1}
+  commas: {min-spaces-after: 1, max-spaces-after: 1}
+  comments:
+    require-starting-space: true
+    min-spaces-from-content: 1
+  comments-indentation: disable
+  document-start:
+    present: true
+  empty-lines:
+    max: 3
+    max-end: 1
+  empty-values:
+    forbid-in-block-mappings: true
+    forbid-in-flow-mappings: true
+  hyphens:
+    max-spaces-after: 1
+  indentation:
+    spaces: 2
+    indent-sequences: true
+    check-multi-line-strings: false
+  trailing-spaces: false

dtschema/meta-schemas/base.yaml

@@ -20,8 +20,8 @@ properties:
     pattern: 'http://devicetree.org/schemas(/[^/ ]+)+\.yaml#'
   $schema:
     enum:
-      - "http://devicetree.org/meta-schemas/core.yaml#"
-      - "http://devicetree.org/meta-schemas/base.yaml#"
+      - http://devicetree.org/meta-schemas/core.yaml#
+      - http://devicetree.org/meta-schemas/base.yaml#
   title:
     maxLength: 100
     description:

dtschema/meta-schemas/cell.yaml

@@ -10,8 +10,8 @@ array:
   description: cell array properties must define how many entries and what the
     entries are when there is more than one entry.
   anyOf:
-    - description: 'Only "maxItems" is required for a single entry if there are
-        no constraints defined for the values.'
+    - description: Only "maxItems" is required for a single entry if there are
+        no constraints defined for the values.
       properties:
         maxItems:
           const: 1

dtschema/meta-schemas/core.yaml

@@ -25,7 +25,7 @@ definitions:
 
   all-properties:
     allOf:
-      - $ref: "#/definitions/core-properties"
+      - $ref: '#/definitions/core-properties'
       - $ref: clocks.yaml#
       - $ref: dma.yaml#
       - $ref: gpios.yaml#
@@ -86,9 +86,9 @@ definitions:
           type:
             enum: [ boolean, object ]
           properties:
-            $ref: "#/definitions/all-properties"
+            $ref: '#/definitions/all-properties'
           patternProperties:
-            $ref: "#/definitions/all-properties"
+            $ref: '#/definitions/all-properties'
           $ref:
             pattern: '(#$|#\/)?'
 
@@ -111,42 +111,42 @@ definitions:
                 - required: [ $ref ]
 
     dependentRequired:
-      "#size-cells": [ "#address-cells" ]
+      '#size-cells': [ '#address-cells' ]
       memory-region-names: [ memory-region ]
       reg-names: [ reg ]
 
 properties:
   patternProperties:
-    $ref: "#/definitions/all-properties"
+    $ref: '#/definitions/all-properties'
   properties:
-    $ref: "#/definitions/all-properties"
+    $ref: '#/definitions/all-properties'
   allOf:
     items:
       properties:
         properties:
-          $ref: "#/definitions/all-properties"
+          $ref: '#/definitions/all-properties'
         patternProperties:
-          $ref: "#/definitions/all-properties"
+          $ref: '#/definitions/all-properties'
   anyOf:
     items:
       properties:
         properties:
-          $ref: "#/definitions/all-properties"
+          $ref: '#/definitions/all-properties'
         patternProperties:
-          $ref: "#/definitions/all-properties"
+          $ref: '#/definitions/all-properties'
   oneOf:
     items:
       properties:
         properties:
-          $ref: "#/definitions/all-properties"
+          $ref: '#/definitions/all-properties'
         patternProperties:
-          $ref: "#/definitions/all-properties"
+          $ref: '#/definitions/all-properties'
   if:
     properties:
       properties:
-        $ref: "#/definitions/all-properties"
+        $ref: '#/definitions/all-properties'
       patternProperties:
-        $ref: "#/definitions/all-properties"
+        $ref: '#/definitions/all-properties'
 
 anyOf:
   - required:

dtschema/meta-schemas/interrupts.yaml

@@ -28,10 +28,10 @@ properties:
 
 dependentRequired:
   interrupt-map: ['#interrupt-cells']
-  'interrupt-map-mask': [ interrupt-map ]
+  interrupt-map-mask: [ interrupt-map ]
 
 dependentSchemas:
-  'interrupts':
+  interrupts:
     properties:
       interrupt-parent: false # interrupt-parent is implicitly allowed (added by tooling)
 

dtschema/meta-schemas/keywords.yaml

@@ -52,14 +52,14 @@ definitions:
 
   sub-schemas:
     allOf:
-      - $ref: "#"
+      - $ref: '#'
       - $ref: items.yaml#
       - $ref: types.yaml#
     propertyNames:
       # The subset of keywords allowed for sub-schema
       anyOf:
-        - $ref: "#/definitions/json-schema-prop-names"
-        - $ref: "#/definitions/overlapping-json-schema-prop-names"
+        - $ref: '#/definitions/json-schema-prop-names'
+        - $ref: '#/definitions/overlapping-json-schema-prop-names'
 
   scalar-prop-list:
     propertyNames:
@@ -79,19 +79,20 @@ definitions:
 # Array keywords should not be mixed with scalar keywords
 dependentSchemas:
   contains:
-    $ref: "#/definitions/scalar-prop-list"
+    $ref: '#/definitions/scalar-prop-list'
   items:
-    $ref: "#/definitions/scalar-prop-list"
+    $ref: '#/definitions/scalar-prop-list'
   maxItems:
-    $ref: "#/definitions/scalar-prop-list"
+    $ref: '#/definitions/scalar-prop-list'
   minItems:
-    $ref: "#/definitions/scalar-prop-list"
+    $ref: '#/definitions/scalar-prop-list'
   additionalProperties:
-    description: "'additionalProperties' depends on 'properties' or 'patternProperties'"
+    description: >
+      'additionalProperties' depends on 'properties' or 'patternProperties'
     if:
       properties:
         additionalProperties:
-            type: boolean
+          type: boolean
     then:
       anyOf:
         - required: [ type ]
@@ -113,11 +114,11 @@ properties:
     propertyNames:
       description: A json-schema keyword was found in $defs key.
       not:
-        $ref: "#/definitions/json-schema-prop-names"
+        $ref: '#/definitions/json-schema-prop-names'
     additionalProperties:
       description: $defs entries must contain schemas
       type: object
-      $ref: "#/definitions/sub-schemas"
+      $ref: '#/definitions/sub-schemas'
   $ref:
     description:
       References must start with '/schemas' or be relative to current
@@ -129,38 +130,39 @@ properties:
     oneOf:
       - type: object
         allOf:
-          - $ref: "#/definitions/sub-schemas"
+          - $ref: '#/definitions/sub-schemas'
       - type: boolean
   additionalProperties:
     oneOf:
       - type: object
         allOf:
-          - $ref: "#/definitions/sub-schemas"
+          - $ref: '#/definitions/sub-schemas'
       - type: boolean
   allOf:
     uniqueItems: true
     items:
-      $ref: "#/definitions/sub-schemas"
+      $ref: '#/definitions/sub-schemas'
   anyOf:
     uniqueItems: true
     items:
-      $ref: "#/definitions/sub-schemas"
+      $ref: '#/definitions/sub-schemas'
   contains:
-    $ref: "#/definitions/sub-schemas"
+    $ref: '#/definitions/sub-schemas'
   dependencies:
     additionalProperties:
-      $ref: "#/definitions/sub-schemas"
+      $ref: '#/definitions/sub-schemas'
   dependentRequired:
     uniqueItems: true
   dependentSchemas:
     additionalProperties:
-      $ref: "#/definitions/sub-schemas"
+      $ref: '#/definitions/sub-schemas'
   else:
-    $ref: "#/definitions/sub-schemas"
+    $ref: '#/definitions/sub-schemas'
   const:
     type: [ integer, string ]
   enum:
-    description: '"enum" must be an array of either integers or strings'
+    description: >
+      "enum" must be an array of either integers or strings'
     type: array
     uniqueItems: true
     oneOf:
@@ -169,27 +171,27 @@ properties:
       - items:
           type: string
   if:
-    $ref: "#/definitions/sub-schemas"
+    $ref: '#/definitions/sub-schemas'
   items:
     if:
       type: object
     then:
-      $ref: "#/definitions/sub-schemas"
+      $ref: '#/definitions/sub-schemas'
     else:
       type: array
       items:
-        $ref: "#/definitions/sub-schemas"
+        $ref: '#/definitions/sub-schemas'
   maxItems:
     minimum: 1
   minItems:
     description: An array property has at least 1 item or is not present
     minimum: 1
   not:
-    $ref: "#/definitions/sub-schemas"
+    $ref: '#/definitions/sub-schemas'
   oneOf:
     allOf:
       - items:
-          $ref: "#/definitions/sub-schemas"
+          $ref: '#/definitions/sub-schemas'
       - description: Use 'enum' rather than 'oneOf' + 'const' entries
         not:
           items:
@@ -203,38 +205,39 @@ properties:
         - description: Fixed strings belong in 'properties', not 'patternProperties'
           pattern: '[\^$()*@]'
           not:
-            pattern:  '^\^[a-zA-Z0-9,\-._#@]+\$$'
+            pattern: '^\^[a-zA-Z0-9,\-._#@]+\$$'
         - description: A json-schema keyword was found instead of a DT property name.
           not:
-            $ref: "#/definitions/json-schema-prop-names"
+            $ref: '#/definitions/json-schema-prop-names'
     additionalProperties:
-      $ref: "#/definitions/sub-schemas"
+      $ref: '#/definitions/sub-schemas'
   properties:
     propertyNames:
       allOf:
         - description: Expected a valid DT property name
-          pattern:  "^[#$a-zA-Z][a-zA-Z0-9#,+\\-._@]{0,63}$"
+          pattern: '^[#$a-zA-Z][a-zA-Z0-9#,+\-._@]{0,63}$'
         - description: A json-schema keyword was found instead of a DT property name.
           not:
-            $ref: "#/definitions/json-schema-prop-names"
+            $ref: '#/definitions/json-schema-prop-names'
     additionalProperties:
       type: [ object, boolean ]
-      $ref: "#/definitions/sub-schemas"
+      $ref: '#/definitions/sub-schemas'
   required:
-    description: "'required' must be valid DT property or node names"
+    description: >
+      'required' must be valid DT property or node names
     type: array
     uniqueItems: true
     items:
       pattern: '^([a-zA-Z#][a-zA-Z0-9#,+\-._@]{0,63}|\$nodename)$'
   select:
-    $ref: "#/definitions/sub-schemas"
+    $ref: '#/definitions/sub-schemas'
   then:
-    $ref: "#/definitions/sub-schemas"
+    $ref: '#/definitions/sub-schemas'
   unevaluatedProperties:
     if:
       type: object
     then:
-      $ref: "#/definitions/sub-schemas"
+      $ref: '#/definitions/sub-schemas'
     else:
       type: boolean
   uniqueItems:

dtschema/meta-schemas/nodes.yaml

@@ -7,7 +7,7 @@ $schema: https://json-schema.org/draft/2019-09/schema
 
 type: object
 
-description: 'DT nodes ("object" type in schemas) can only use a subset of json-schema keywords'
+description: DT nodes ("object" type in schemas) can only use a subset of json-schema keywords.
 
 properties:
   type:

dtschema/meta-schemas/string-array.yaml

@@ -5,7 +5,6 @@
 ---
 $id: http://devicetree.org/meta-schemas/string-array.yaml#
 $schema: https://json-schema.org/draft/2019-09/schema
-#type: object
 
 if:
   not: