[PATCH] dt-bindings: net: adin: Escape a trailing ":"

[PATCH] dt-bindings: net: adin: Escape a trailing ":"

[Palmer Dabbelt]

From: Palmer Dabbelt <palmer@rivosinc.com>

1f77204e11f8 ("dt-bindings: net: adin: document phy clock output
properties") added a line with a ":" at the end, which is tripping up my
attempts to run the DT schema checks due to this being invalid YAML
syntax.  I get a schema check failure with the following error

    ruamel.yaml.scanner.ScannerError: mapping values are not allowed in this context

This just escapes the line in question, so it can parse.

Fixes: 1f77204e11f8 ("dt-bindings: net: adin: document phy clock output properties")
Signed-off-by: Palmer Dabbelt <palmer@rivosinc.com>
---
 Documentation/devicetree/bindings/net/adi,adin.yaml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/net/adi,adin.yaml b/Documentation/devicetree/bindings/net/adi,adin.yaml
index 77750df0c2c4..88611720545d 100644
--- a/Documentation/devicetree/bindings/net/adi,adin.yaml
+++ b/Documentation/devicetree/bindings/net/adi,adin.yaml
@@ -37,7 +37,8 @@ properties:
     default: 8
 
   adi,phy-output-clock:
-    description: Select clock output on GP_CLK pin. Two clocks are available:
+    description: |
+      Select clock output on GP_CLK pin. Two clocks are available:
       A 25MHz reference and a free-running 125MHz.
       The phy can alternatively automatically switch between the reference and
       the 125MHz clocks based on its internal state.
-- 
2.34.1

Re: [PATCH] dt-bindings: net: adin: Escape a trailing ":"

[Rob Herring]

On Wed, Jun 01, 2022 at 06:28:09PM -0700, Palmer Dabbelt wrote:
> From: Palmer Dabbelt <palmer@rivosinc.com>
> 
> 1f77204e11f8 ("dt-bindings: net: adin: document phy clock output
> properties") added a line with a ":" at the end, which is tripping up my
> attempts to run the DT schema checks due to this being invalid YAML
> syntax.  I get a schema check failure with the following error
> 
>     ruamel.yaml.scanner.ScannerError: mapping values are not allowed in this context
> 
> This just escapes the line in question, so it can parse.
> 
> Fixes: 1f77204e11f8 ("dt-bindings: net: adin: document phy clock output properties")
> Signed-off-by: Palmer Dabbelt <palmer@rivosinc.com>
> ---
>  Documentation/devicetree/bindings/net/adi,adin.yaml | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)

Already have a fix queued in netdev.

Rob

Re: [PATCH] dt-bindings: net: adin: Escape a trailing ":"

[Palmer Dabbelt]

On Thu, 02 Jun 2022 07:29:17 PDT (-0700), Rob Herring wrote:
> On Wed, Jun 01, 2022 at 06:28:09PM -0700, Palmer Dabbelt wrote:
>> From: Palmer Dabbelt <palmer@rivosinc.com>
>>
>> 1f77204e11f8 ("dt-bindings: net: adin: document phy clock output
>> properties") added a line with a ":" at the end, which is tripping up my
>> attempts to run the DT schema checks due to this being invalid YAML
>> syntax.  I get a schema check failure with the following error
>>
>>     ruamel.yaml.scanner.ScannerError: mapping values are not allowed in this context
>>
>> This just escapes the line in question, so it can parse.
>>
>> Fixes: 1f77204e11f8 ("dt-bindings: net: adin: document phy clock output properties")
>> Signed-off-by: Palmer Dabbelt <palmer@rivosinc.com>
>> ---
>>  Documentation/devicetree/bindings/net/adi,adin.yaml | 3 ++-
>>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> Already have a fix queued in netdev.

OK, thanks!