diff mbox

[v2,2/4] mfd: max77686: Use a generic name for the PMIC node in the example

Message ID 1437114567-17629-3-git-send-email-javier@osg.samsung.com (mailing list archive)
State New, archived
Headers show

Commit Message

Javier Martinez Canillas July 17, 2015, 6:29 a.m. UTC
The ePAR standard says that: "the name of a node should be somewhat
generic, reflecting the function of the device and not its precise
programming model."

So, change the max77686 binding document example to use a generic
node name instead of using the chip's name.

Suggested-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
---

Changes in v2: None

 Documentation/devicetree/bindings/mfd/max77686.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Sergei Shtylyov July 17, 2015, 9:11 a.m. UTC | #1
Hello.

On 7/17/2015 9:29 AM, Javier Martinez Canillas wrote:

> The ePAR standard says that: "the name of a node should be somewhat

    ePAPR.

> generic, reflecting the function of the device and not its precise
> programming model."

> So, change the max77686 binding document example to use a generic
> node name instead of using the chip's name.

> Suggested-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>

MBR, Sergei
Javier Martinez Canillas July 17, 2015, 9:19 a.m. UTC | #2
Hello Sergei,

On 07/17/2015 11:11 AM, Sergei Shtylyov wrote:
> Hello.
> 
> On 7/17/2015 9:29 AM, Javier Martinez Canillas wrote:
> 
>> The ePAR standard says that: "the name of a node should be somewhat
> 
>    ePAPR.
>

Thanks for pointing it out. I guess that Lee can fix the typo when applying?

>> generic, reflecting the function of the device and not its precise
>> programming model."
> 
>> So, change the max77686 binding document example to use a generic
>> node name instead of using the chip's name.
> 
>> Suggested-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com>
>> Signed-off-by: Javier Martinez Canillas <javier@osg.samsung.com>
> 
> MBR, Sergei
> 

Best regards,
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/mfd/max77686.txt b/Documentation/devicetree/bindings/mfd/max77686.txt
index 8221102d3fc2..d2ed3c20a5c3 100644
--- a/Documentation/devicetree/bindings/mfd/max77686.txt
+++ b/Documentation/devicetree/bindings/mfd/max77686.txt
@@ -48,7 +48,7 @@  to get matched with their hardware counterparts as follow:
 
 Example:
 
-	max77686@09 {
+	max77686: pmic@09 {
 		compatible = "maxim,max77686";
 		interrupt-parent = <&wakeup_eint>;
 		interrupts = <26 0>;