diff mbox

[v2,net-next] net: hisilicon: fix binding document of mdio

Message ID 1447666704-200773-1-git-send-email-huangdaode@hisilicon.com (mailing list archive)
State New, archived
Headers show

Commit Message

huangdaode Nov. 16, 2015, 9:38 a.m. UTC
This patch explains the occasion of "hisilcon,mdio" and
"hisilicon,hns-mdio" according to Arnd's comments.
and reformat it according to comments from Rob<robh@kernel.org>.

chang log:

v2:
  1) reformat the style.
  2) make it more clearity.

v1:
  initial version.

Signed-off-by: huangdaode <huangdaode@hisilicon.com>
---
 Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

Comments

Arnd Bergmann Nov. 16, 2015, 9:38 a.m. UTC | #1
On Monday 16 November 2015 17:38:24 huangdaode wrote:
> This patch explains the occasion of "hisilcon,mdio" and
> "hisilicon,hns-mdio" according to Arnd's comments.
> and reformat it according to comments from Rob<robh@kernel.org>.
> 
> chang log:
> 
> v2:
>   1) reformat the style.
>   2) make it more clearity.
> 
> v1:
>   initial version.
> 
> Signed-off-by: huangdaode <huangdaode@hisilicon.com>
> ---

The new version looks ok, but your changelog above is formatted
incorrectly. Please put only the contents you want in the git history
above the '---' line and your Signed-off-by, but put the parts that
refer to previous versions of the submission below the ---.

>  Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt | 7 ++++++-
>  1 file changed, 6 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt b/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt
> index 9c23fdf..4942d20 100644
> --- a/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt
> +++ b/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt
> @@ -1,7 +1,12 @@
>  Hisilicon MDIO bus controller
>  
>  Properties:
> -- compatible: "hisilicon,mdio","hisilicon,hns-mdio".
> +- compatible: can be one of:
> +	"hisilicon,hns-mdio"
> +	"hisilicon,mdio"
> +  "hisilicon,hns-mdio" is recommendly to be used for hip05 and later SOCs,
> +  while "hisilicon,mdio" is optional for backwards compatibility, only
> +  support for hip04 Soc.
>  - reg: The base address of the MDIO bus controller register bank.
>  - #address-cells: Must be <1>.
>  - #size-cells: Must be <0>.  MDIO addresses have no size component.
>
Rob Herring (Arm) Nov. 16, 2015, 3:20 p.m. UTC | #2
On Mon, Nov 16, 2015 at 05:38:24PM +0800, huangdaode wrote:
> This patch explains the occasion of "hisilcon,mdio" and
> "hisilicon,hns-mdio" according to Arnd's comments.
> and reformat it according to comments from Rob<robh@kernel.org>.
> 
> chang log:
> 
> v2:
>   1) reformat the style.
>   2) make it more clearity.
> 
> v1:
>   initial version.
> 
> Signed-off-by: huangdaode <huangdaode@hisilicon.com>
> ---
>  Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt | 7 ++++++-
>  1 file changed, 6 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt b/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt
> index 9c23fdf..4942d20 100644
> --- a/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt
> +++ b/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt
> @@ -1,7 +1,12 @@
>  Hisilicon MDIO bus controller
>  
>  Properties:
> -- compatible: "hisilicon,mdio","hisilicon,hns-mdio".
> +- compatible: can be one of:
> +	"hisilicon,hns-mdio"
> +	"hisilicon,mdio"
> +  "hisilicon,hns-mdio" is recommendly to be used for hip05 and later SOCs,

s/recommendly/recommended/

> +  while "hisilicon,mdio" is optional for backwards compatibility, only
> +  support for hip04 Soc.

...compatibility only on hip04 SOC.

>  - reg: The base address of the MDIO bus controller register bank.
>  - #address-cells: Must be <1>.
>  - #size-cells: Must be <0>.  MDIO addresses have no size component.
> -- 
> 1.9.1
> 
> --
> 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
huangdaode Nov. 18, 2015, 1:42 a.m. UTC | #3
On 2015/11/16 17:38, Arnd Bergmann wrote:
> On Monday 16 November 2015 17:38:24 huangdaode wrote:
>> This patch explains the occasion of "hisilcon,mdio" and
>> "hisilicon,hns-mdio" according to Arnd's comments.
>> and reformat it according to comments from Rob<robh@kernel.org>.
>>
>> chang log:
>>
>> v2:
>>    1) reformat the style.
>>    2) make it more clearity.
>>
>> v1:
>>    initial version.
>>
>> Signed-off-by: huangdaode <huangdaode@hisilicon.com>
>> ---
> The new version looks ok, but your changelog above is formatted
> incorrectly. Please put only the contents you want in the git history
> above the '---' line and your Signed-off-by, but put the parts that
> refer to previous versions of the submission below the ---.

Got it.
thanks Arnd.

Daode

>>   Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt | 7 ++++++-
>>   1 file changed, 6 insertions(+), 1 deletion(-)
>>
>> diff --git a/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt b/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt
>> index 9c23fdf..4942d20 100644
>> --- a/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt
>> +++ b/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt
>> @@ -1,7 +1,12 @@
>>   Hisilicon MDIO bus controller
>>   
>>   Properties:
>> -- compatible: "hisilicon,mdio","hisilicon,hns-mdio".
>> +- compatible: can be one of:
>> +	"hisilicon,hns-mdio"
>> +	"hisilicon,mdio"
>> +  "hisilicon,hns-mdio" is recommendly to be used for hip05 and later SOCs,
>> +  while "hisilicon,mdio" is optional for backwards compatibility, only
>> +  support for hip04 Soc.
>>   - reg: The base address of the MDIO bus controller register bank.
>>   - #address-cells: Must be <1>.
>>   - #size-cells: Must be <0>.  MDIO addresses have no size component.
>>
>
> .
>
huangdaode Nov. 18, 2015, 1:43 a.m. UTC | #4
On 2015/11/16 23:20, Rob Herring wrote:
> On Mon, Nov 16, 2015 at 05:38:24PM +0800, huangdaode wrote:
>> This patch explains the occasion of "hisilcon,mdio" and
>> "hisilicon,hns-mdio" according to Arnd's comments.
>> and reformat it according to comments from Rob<robh@kernel.org>.
>>
>> chang log:
>>
>> v2:
>>    1) reformat the style.
>>    2) make it more clearity.
>>
>> v1:
>>    initial version.
>>
>> Signed-off-by: huangdaode <huangdaode@hisilicon.com>
>> ---
>>   Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt | 7 ++++++-
>>   1 file changed, 6 insertions(+), 1 deletion(-)
>>
>> diff --git a/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt b/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt
>> index 9c23fdf..4942d20 100644
>> --- a/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt
>> +++ b/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt
>> @@ -1,7 +1,12 @@
>>   Hisilicon MDIO bus controller
>>   
>>   Properties:
>> -- compatible: "hisilicon,mdio","hisilicon,hns-mdio".
>> +- compatible: can be one of:
>> +	"hisilicon,hns-mdio"
>> +	"hisilicon,mdio"
>> +  "hisilicon,hns-mdio" is recommendly to be used for hip05 and later SOCs,
> s/recommendly/recommended/
>
>> +  while "hisilicon,mdio" is optional for backwards compatibility, only
>> +  support for hip04 Soc.
> ...compatibility only on hip04 SOC.
>
>>   - reg: The base address of the MDIO bus controller register bank.
>>   - #address-cells: Must be <1>.
>>   - #size-cells: Must be <0>.  MDIO addresses have no size component.
>> -- 
>> 1.9.1
>>
>> --
>> 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

Agreed.
Will fix this in v3 patch.

thanks
Daode.

> .
>
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt b/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt
index 9c23fdf..4942d20 100644
--- a/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt
+++ b/Documentation/devicetree/bindings/net/hisilicon-hns-mdio.txt
@@ -1,7 +1,12 @@ 
 Hisilicon MDIO bus controller
 
 Properties:
-- compatible: "hisilicon,mdio","hisilicon,hns-mdio".
+- compatible: can be one of:
+	"hisilicon,hns-mdio"
+	"hisilicon,mdio"
+  "hisilicon,hns-mdio" is recommendly to be used for hip05 and later SOCs,
+  while "hisilicon,mdio" is optional for backwards compatibility, only
+  support for hip04 Soc.
 - reg: The base address of the MDIO bus controller register bank.
 - #address-cells: Must be <1>.
 - #size-cells: Must be <0>.  MDIO addresses have no size component.