From: Lee Jones <lee.jones@linaro.org>
To: Milo Kim <milo.kim@ti.com>
Cc: Samuel Ortiz <sameo@linux.intel.com>,
linux-kernel@vger.kernel.org, linux-pwm@vger.kernel.org,
Linus Walleij <linus.walleij@linaro.org>,
Thierry Reding <thierry.reding@gmail.com>,
devicetree@vger.kernel.org
Subject: Re: [PATCH v3 4/4] Documentation: add LP3943 DT bindings and document
Date: Mon, 23 Sep 2013 08:58:10 +0100 [thread overview]
Message-ID: <20130923075810.GC2185@lee--X1> (raw)
In-Reply-To: <523F0040.6050900@ti.com>
> >>+++ b/Documentation/lp3943.txt
> >>@@ -0,0 +1,62 @@
> >>+TI/National Semiconductor LP3943 MFD driver
> >>+===========================================
<snip>
> >Why do you need to document your driver in this way?
> >
> >If this stuff is really important (and most of it really isn't), then
> >put it either in the commit log or in the driver.
>
> Unnecessary documentation makes it noisy, but I think the LP3943
> still needs the driver documentation for better understanding.
>
> Many people think LP3943 is just LED driver, but I really want to
> share the application usages - PWM generators and GPIO expanders.
> If the driver just supports LED functionality, then it would be
> created as LED class driver. However, this patch-set enables more
> generic driver usages.
> So, this documentation would be helpful.
>
> And I want to keep the code and the documentation separate.
> If the link address is changed, then only documentation file will be
> modified, not source file.
>
> So, I'd like to create the fifth patch-set with new MFD
> documentation subdirectory.
> Additionally, LP3943 platform data example code will be added in the
> 'Documentation/mfd/lp3943.txt'. It's for a platform which doesn't
> support the device tree.
So, I'd actually like to get Sam's opinion on this.
NB: The documentation looks pretty rough at the moment. If we decide
to accept the concept, it will have to be adapted quite a bit before
full acceptance of the document will be granted.
--
Lee Jones
Linaro STMicroelectronics Landing Team Lead
Linaro.org │ Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog
prev parent reply other threads:[~2013-09-23 7:58 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-09-12 1:35 [PATCH v3 4/4] Documentation: add LP3943 DT bindings and document Milo Kim
2013-09-12 15:24 ` Lee Jones
2013-09-15 11:27 ` Thierry Reding
2013-09-16 7:30 ` Lee Jones
2013-09-19 11:25 ` Thierry Reding
2013-09-19 11:56 ` Lee Jones
2013-09-22 14:35 ` Milo Kim
2013-09-23 7:58 ` Lee Jones [this message]
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=20130923075810.GC2185@lee--X1 \
--to=lee.jones@linaro.org \
--cc=devicetree@vger.kernel.org \
--cc=linus.walleij@linaro.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pwm@vger.kernel.org \
--cc=milo.kim@ti.com \
--cc=sameo@linux.intel.com \
--cc=thierry.reding@gmail.com \
/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).