From: Rhyland Klein <rklein-DDmLM1+adcrQT0dZR+AlfA@public.gmane.org>
To: Stephen Warren <swarren-3lzwWm7+Weoh9ZMKESR00Q@public.gmane.org>
Cc: Grant Likely
	<grant.likely-s3s/WqlpOiPyB63q8FvJNQ@public.gmane.org>,
	Samuel Ortiz <sameo-VuQAYsv1563Yd54FQh9/CA@public.gmane.org>,
	Anton Vorontsov <cbou-JGs/UdohzUI@public.gmane.org>,
	Mark Brown
	<broonie-yzvPICuk2AATkU/dhu1WVueM+bqZidxxQQ4Iyu8u01E@public.gmane.org>,
	"linux-tegra-u79uwXL29TY76Z2rM5mHXA@public.gmane.org"
	<linux-tegra-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>,
	"devicetree-discuss-uLR06cmDAlY/bJ5BZ2RsiQ@public.gmane.org"
	<devicetree-discuss-uLR06cmDAlY/bJ5BZ2RsiQ@public.gmane.org>,
	Laxman Dewangan
	<ldewangan-DDmLM1+adcrQT0dZR+AlfA@public.gmane.org>,
	"linux-kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org"
	<linux-kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>
Subject: Re: [PATCH v2 3/4] power_supply: tps65090-charger: Add binding doc
Date: Tue, 5 Mar 2013 14:12:38 -0500	[thread overview]
Message-ID: <513643A6.4020109@nvidia.com> (raw)
In-Reply-To: <5136364B.7000506-3lzwWm7+Weoh9ZMKESR00Q@public.gmane.org>
On 3/5/2013 1:15 PM, Stephen Warren wrote:
> On 03/04/2013 12:01 PM, Rhyland Klein wrote:
>> This change adds the binding documentation for the tps65090-charger.
>> diff --git a/Documentation/devicetree/bindings/power_supply/tps65090.txt b/Documentation/devicetree/bindings/power_supply/tps65090.txt
> ...
>> +Example:
>> +
>> +	tps65090@48 {
> ...
>> +		regulators {
>> +			...
>> +		};
>>
> The "regulators" node in the example isn't mentioned in the list of
> properties/nodes that's above. What goes in there? You probably want to
> include text similar to what I've quoted below from
> Documentation/devicetree/bindings/regulator/tps6586x.txt:
>
>> - regulators: A node that houses a sub-node for each regulator within the
>>    device. Each sub-node is identified using the node's name (or the deprecated
>>    regulator-compatible property if present), with valid values listed below.
>>    The content of each sub-node is defined by the standard binding for
>>    regulators; see regulator.txt.
>>    sys, sm[0-2], ldo[0-9] and ldo_rtc
The reason I didn't bother documenting the regulators node was that 
since this is a child device
driver of an mfd device, there is already a child driver for the 
regulators with its own documentation
https://patchwork.kernel.org/patch/2051381/
I wasn't sure how I should handle this, as splitting the bindings to 
make logic sense in the binding
layout (charger under power_supply, and  regulators under regulator) or 
combine them somehow
into a single documentation entry common to the device. The latter seems 
to make more sense to me,
but since there aren't any dt specific entries for the core mfd part 
currently, it doesn't have its own
documentation, and sticking the charger info under the regulators seemed 
backwards to me.
I thought doing it this way would be a good way of starting a discussion 
around how to handle this.
thanks for starting it Stephen :)
-rhyland
-- 
nvpublic
next prev parent reply	other threads:[~2013-03-05 19:12 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-03-04 19:01 [PATCH v2 0/4] Add support for tps65090-charger Rhyland Klein
2013-03-04 19:01 ` [PATCH v2 1/4] mfd: tps65090: Fix enum in header file Rhyland Klein
     [not found] ` <1362423709-29596-1-git-send-email-rklein-DDmLM1+adcrQT0dZR+AlfA@public.gmane.org>
2013-03-04 19:01   ` [PATCH v2 2/4] mfd: tps65090: Add resources for charger Rhyland Klein
2013-03-04 19:01 ` [PATCH v2 3/4] power_supply: tps65090-charger: Add binding doc Rhyland Klein
     [not found]   ` <1362423709-29596-4-git-send-email-rklein-DDmLM1+adcrQT0dZR+AlfA@public.gmane.org>
2013-03-05 18:15     ` Stephen Warren
     [not found]       ` <5136364B.7000506-3lzwWm7+Weoh9ZMKESR00Q@public.gmane.org>
2013-03-05 19:12         ` Rhyland Klein [this message]
     [not found]           ` <513643A6.4020109-DDmLM1+adcrQT0dZR+AlfA@public.gmane.org>
2013-03-05 19:25             ` Stephen Warren
2013-03-04 19:01 ` [PATCH v2 4/4] power: tps65090: Add support for tps65090-charger Rhyland Klein
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox
  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):
  git send-email \
    --in-reply-to=513643A6.4020109@nvidia.com \
    --to=rklein-ddmlm1+adcrqt0dzr+alfa@public.gmane.org \
    --cc=broonie-yzvPICuk2AATkU/dhu1WVueM+bqZidxxQQ4Iyu8u01E@public.gmane.org \
    --cc=cbou-JGs/UdohzUI@public.gmane.org \
    --cc=devicetree-discuss-uLR06cmDAlY/bJ5BZ2RsiQ@public.gmane.org \
    --cc=grant.likely-s3s/WqlpOiPyB63q8FvJNQ@public.gmane.org \
    --cc=ldewangan-DDmLM1+adcrQT0dZR+AlfA@public.gmane.org \
    --cc=linux-kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=linux-tegra-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=sameo-VuQAYsv1563Yd54FQh9/CA@public.gmane.org \
    --cc=swarren-3lzwWm7+Weoh9ZMKESR00Q@public.gmane.org \
    /path/to/YOUR_REPLY
  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
  Be sure your reply has a Subject: header at the top and a blank line
  before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).