From: tomasz.figa@gmail.com (Tomasz Figa)
To: linux-arm-kernel@lists.infradead.org
Subject: Do we have people interested in device tree janitoring / cleanup?
Date: Thu, 25 Jul 2013 01:29:28 +0200 [thread overview]
Message-ID: <3403223.vsyjiUcZ9s@flatron> (raw)
In-Reply-To: <20130724190315.GC23879@titan.lakedaemon.net>
On Wednesday 24 of July 2013 15:03:15 Jason Cooper wrote:
> On Wed, Jul 24, 2013 at 01:31:00PM -0500, Rob Herring wrote:
> > On 07/24/2013 10:27 AM, Olof Johansson wrote:
> > > Every now and then I come across a binding that's just done
> > > Wrong(tm),
> > > merged through a submaintainer tree and hasn't seen proper review --
> > > if it had, it wouldn't look the way it does. It's something we're
> > > starting to address now since there's more people stepping up to be
> > > maintainers, but there's a backlog of bad bindings already merged.
> > >
> > > Often they are produced by translating the platform_data structures
> > > directly over into device-tree properties without consideration to
> > > describing the hardware or usual conventions, using key/value pairs
> > > instead of boolean properties, etc.
> > >
> > > Getting involved in cleaning up these kind of bindings is a great
> > > way
> > > to learn "the ways of device tree" for someone that has interest in
> > > that.
> > >
> > > Latest find in this area is the Maxim 8925 bindings, that I came
> > > across since they caused a compile warning on some defconfig. I'll
> > > post a patch to address the warning but if someone else feels like
> > > fixing the bindings on top of it that would be appreciated!
> >
> > Are they documented typically? Can we at a minimum update the
> > documentation with a big fat warning to not use or propagate the crap.
> > Or move the binding doc file to a fixme directory.
>
> I agree, in order to do the janitorial work (which I'm not opposed to
> helping with), we need a way to mark stable bindings.
>
> fwiw, we could do a separate commit (like the kernel version commit)
> where the only change is marking a binding as stable, and is obvious
> from a 'git log --oneline'. eg:
>
> ---->8------
>
> From 65c069678cdbd5aaa6aca0d4062dab6eb9f9904c Mon Sep 17 00:00:00 2001
> From: Jason Cooper <jason@lakedaemon.net>
> Date: Wed, 24 Jul 2013 18:49:28 +0000
> Subject: [PATCH] DT: binding: stable: gpio-regulator
>
> A whole bunch of folks reviewed this and think it kicks ass.
>
> List-of-people-responsible-for-this-travesty: ...
> Signed-off-by: Jason Cooper <jason@lakedaemon.net>
> ---
> Documentation/devicetree/bindings/regulator/gpio-regulator.txt | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git
> a/Documentation/devicetree/bindings/regulator/gpio-regulator.txt
> b/Documentation/devicetree/bindings/regulator/gpio-regulator.txt index
> 63c6598..35ec635 100644
> --- a/Documentation/devicetree/bindings/regulator/gpio-regulator.txt
> +++ b/Documentation/devicetree/bindings/regulator/gpio-regulator.txt
> @@ -1,3 +1,5 @@
> +Binding status: Stable
> +
> GPIO controlled regulators
>
> Required properties:
This looks fine for me, but what about adopting the scheme used for
drivers and having a staging subdirectory inside bindings/ directory where
a whole tree of staging bindings would be located? Then marking a binding
as stable would mean moving it out of this directory.
As for janitoring/cleanup itself, we should start some witch^Wbinding-hunt
to check all the existing binding for sanity and probably make a list of
bindings that are not acceptable and possibly contact people responsible
for them as they are primary candidates to work on fixing bindings they
introduced.
I also think we should start the periodic binding review meetings and get
some bindings stabilized, so they could be used as good examples for
people working on new bindings or fixing existing ones.
Best regards,
Tomasz
P.S. Is it just me or something is wrong with devicetree at vger.kernel.org
mailing list? I don't receive any messages from it.
next prev parent reply other threads:[~2013-07-24 23:29 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-07-24 15:27 Do we have people interested in device tree janitoring / cleanup? Olof Johansson
2013-07-24 18:31 ` Rob Herring
2013-07-24 19:03 ` Jason Cooper
2013-07-24 23:29 ` Tomasz Figa [this message]
2013-07-24 23:52 ` Jason Cooper
2013-07-24 23:15 ` Tomasz Figa
2013-07-24 23:20 ` Olof Johansson
2013-07-24 23:22 ` Tomasz Figa
2013-07-24 23:17 ` Domenico Andreoli
2013-07-24 23:20 ` Olof Johansson
2013-07-25 0:36 ` Domenico Andreoli
2013-07-25 0:57 ` Kyle Spaans (CSC)
2013-07-25 11:06 ` Dave Martin
2013-07-25 11:25 ` Russell King - ARM Linux
2013-07-25 13:31 ` Mark Brown
2013-07-25 13:56 ` Domenico Andreoli
2013-07-25 14:27 ` Russell King - ARM Linux
2013-07-25 14:38 ` Catalin Marinas
2013-07-28 4:47 ` Grant Likely
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=3403223.vsyjiUcZ9s@flatron \
--to=tomasz.figa@gmail.com \
--cc=linux-arm-kernel@lists.infradead.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