diff mbox

clk: bindings: Fix assigned-clock-rates property name

Message ID 1430893716-1825-1-git-send-email-k.kozlowski@samsung.com
State Needs Review / ACK, archived
Headers show

Checks

Context Check Description
robh/checkpatch warning total: 1 errors, 0 warnings, 0 lines checked
robh/patch-applied success

Commit Message

Krzysztof Kozlowski May 6, 2015, 6:28 a.m. UTC
In documentation the "assigned-clock-parents" name was used when
describing the "assigned-clock-rates" property.

Signed-off-by: Krzysztof Kozlowski <k.kozlowski@samsung.com>
---
 Documentation/devicetree/bindings/clock/clock-bindings.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Stephen Boyd May 6, 2015, 7:45 a.m. UTC | #1
On 05/06, Krzysztof Kozlowski wrote:
> In documentation the "assigned-clock-parents" name was used when
> describing the "assigned-clock-rates" property.
> 
> Signed-off-by: Krzysztof Kozlowski <k.kozlowski@samsung.com>
> ---

Looks right. The whole sentence could use some work though.

>  Documentation/devicetree/bindings/clock/clock-bindings.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/devicetree/bindings/clock/clock-bindings.txt b/Documentation/devicetree/bindings/clock/clock-bindings.txt
> index 06fc6d541c89..bf5b0414dc17 100644
> --- a/Documentation/devicetree/bindings/clock/clock-bindings.txt
> +++ b/Documentation/devicetree/bindings/clock/clock-bindings.txt
> @@ -138,7 +138,7 @@ Some platforms may require initial configuration of default parent clocks
>  and clock frequencies. Such a configuration can be specified in a device tree
>  node through assigned-clocks, assigned-clock-parents and assigned-clock-rates
>  properties. The assigned-clock-parents property should contain a list of parent
> -clocks in form of phandle and clock specifier pairs, the assigned-clock-parents
> +clocks in form of phandle and clock specifier pairs, the assigned-clock-rates
>  property the list of assigned clock frequency values - corresponding to clocks

This half-sentence:

	The assigned-clock-ratse property the list of assigned
	clock frequency values

doesn't read correctly. Maybe the whole thing should be rewritten
as:

	The assigned-clock-parents property should contain a list
	of parent clocks in the form of a phandle and clock
	specifier pair and the assigned-clock-rates property
	should contain a list of frequencies in Hz. Both these
	properties should correspond to the clocks listed in the
	assigned-clocks property.

>  listed in the assigned-clocks property.
>
Krzysztof Kozlowski May 6, 2015, 8:10 a.m. UTC | #2
On 06.05.2015 16:45, Stephen Boyd wrote:
> On 05/06, Krzysztof Kozlowski wrote:
>> In documentation the "assigned-clock-parents" name was used when
>> describing the "assigned-clock-rates" property.
>>
>> Signed-off-by: Krzysztof Kozlowski <k.kozlowski@samsung.com>
>> ---
>
> Looks right. The whole sentence could use some work though.
>
>>   Documentation/devicetree/bindings/clock/clock-bindings.txt | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/devicetree/bindings/clock/clock-bindings.txt b/Documentation/devicetree/bindings/clock/clock-bindings.txt
>> index 06fc6d541c89..bf5b0414dc17 100644
>> --- a/Documentation/devicetree/bindings/clock/clock-bindings.txt
>> +++ b/Documentation/devicetree/bindings/clock/clock-bindings.txt
>> @@ -138,7 +138,7 @@ Some platforms may require initial configuration of default parent clocks
>>   and clock frequencies. Such a configuration can be specified in a device tree
>>   node through assigned-clocks, assigned-clock-parents and assigned-clock-rates
>>   properties. The assigned-clock-parents property should contain a list of parent
>> -clocks in form of phandle and clock specifier pairs, the assigned-clock-parents
>> +clocks in form of phandle and clock specifier pairs, the assigned-clock-rates
>>   property the list of assigned clock frequency values - corresponding to clocks
>
> This half-sentence:
>
> 	The assigned-clock-ratse property the list of assigned
> 	clock frequency values
>
> doesn't read correctly. Maybe the whole thing should be rewritten
> as:
>
> 	The assigned-clock-parents property should contain a list
> 	of parent clocks in the form of a phandle and clock
> 	specifier pair and the assigned-clock-rates property
> 	should contain a list of frequencies in Hz. Both these
> 	properties should correspond to the clocks listed in the
> 	assigned-clocks property.

Looks much better. So actually this should be yours patch now, you can 
add my Reported-by :).

Best regards,
Krzysztof


--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/clock/clock-bindings.txt b/Documentation/devicetree/bindings/clock/clock-bindings.txt
index 06fc6d541c89..bf5b0414dc17 100644
--- a/Documentation/devicetree/bindings/clock/clock-bindings.txt
+++ b/Documentation/devicetree/bindings/clock/clock-bindings.txt
@@ -138,7 +138,7 @@  Some platforms may require initial configuration of default parent clocks
 and clock frequencies. Such a configuration can be specified in a device tree
 node through assigned-clocks, assigned-clock-parents and assigned-clock-rates
 properties. The assigned-clock-parents property should contain a list of parent
-clocks in form of phandle and clock specifier pairs, the assigned-clock-parents
+clocks in form of phandle and clock specifier pairs, the assigned-clock-rates
 property the list of assigned clock frequency values - corresponding to clocks
 listed in the assigned-clocks property.