dt-bindings: net: adin: use YAML block scalar to avoid parse issue

[PATCH] dt-bindings: net: adin: use YAML block scalar to avoid parse issue

Posted by Chris Packham 3 years, 11 months ago

YAML doesn't like colons (:) in text. Use a block scalar so that the
colon in the description text doesn't cause a parse error.

Fixes: 1f77204e11f8 ("dt-bindings: net: adin: document phy clock output properties")
Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
---
 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.36.1

Re: [PATCH] dt-bindings: net: adin: use YAML block scalar to avoid parse issue

Posted by Jakub Kicinski 3 years, 11 months ago

On Thu, 26 May 2022 16:57:40 +1200 Chris Packham wrote:
> YAML doesn't like colons (:) in text. Use a block scalar so that the
> colon in the description text doesn't cause a parse error.
> 
> Fixes: 1f77204e11f8 ("dt-bindings: net: adin: document phy clock output properties")
> Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>

Got the same fix from Geert already, applying to netdev/net now:

https://lore.kernel.org/all/6fcef2665a6cd86a021509a84c5956ec2efd93ed.1653401420.git.geert+renesas@glider.be/

Re: [PATCH] dt-bindings: net: adin: use YAML block scalar to avoid parse issue

Posted by Chris Packham 3 years, 11 months ago

On 26/05/22 17:02, Jakub Kicinski wrote:
> On Thu, 26 May 2022 16:57:40 +1200 Chris Packham wrote:
>> YAML doesn't like colons (:) in text. Use a block scalar so that the
>> colon in the description text doesn't cause a parse error.
>>
>> Fixes: 1f77204e11f8 ("dt-bindings: net: adin: document phy clock output properties")
>> Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz>
> Got the same fix from Geert already, applying to netdev/net now:
>
> https://lore.kernel.org/all/6fcef2665a6cd86a021509a84c5956ec2efd93ed.1653401420.git.geert+renesas@glider.be/

Good. Sorry for the noise.