Re: [PATCH] Clean up Kconfig and source for a couple device tree commands.

From: Sascha Hauer <s.hauer@pengutronix.de>
To: "Robert P. J. Day" <rpjday@crashcourse.ca>
Cc: "U-Boot Version 2 (barebox)" <barebox@lists.infradead.org>
Subject: Re: [PATCH] Clean up Kconfig and source for a couple device tree commands.
Date: Mon, 7 Jul 2014 14:07:03 +0200	[thread overview]
Message-ID: <20140707120703.GO23235@pengutronix.de> (raw)
In-Reply-To: <alpine.LFD.2.11.1407070606100.3134@localhost>

On Mon, Jul 07, 2014 at 06:07:47AM -0400, Robert P. J. Day wrote:
> On Mon, 7 Jul 2014, Jean-Christophe PLAGNIOL-VILLARD wrote:
> 
> >
> > On Jul 5, 2014, at 12:18 AM, Robert P. J. Day <rpjday@crashcourse.ca> wrote:
> >
> > >
> > >
> > > Correct options listings for a couple device tree-related commands.
> > >
> > > Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
> > >
> > > ---
> > >
> > >  i *think* the following is valid.
> > >
> > > diff --git a/commands/Kconfig b/commands/Kconfig
> > > index eed6fbd..3248de9 100644
> > > --- a/commands/Kconfig
> > > +++ b/commands/Kconfig
> > > @@ -1950,10 +1950,11 @@ config CMD_OFTREE
> > > 	help
> > > 	  oftree - handle device trees
> > >
> > > -	  Usage: oftree [-lpfdn] [DTB]
> > > +	  Usage: oftree [-lspf] [DTB]
> > >
> > > 	  Options:
> > > 		  -l		Load DTB to internal device tree
> > > +		  -s		save internal device tree to DTB
> > > 		  -p		probe devices from stored device tree
> > > 		  -f		free stored device tree
> > >
> >
> > do we really need the help here
> >
> > it’s a pain in the ass to keep it sync
> 
>   as a followup to my reply, if it were me, i would just toss all the
> usage/synopsis info from the Kconfig help -- as the OP quite
> correctly points out, it's a pain in the ass to keep it sync'ed with
> the source, and i've already run across several commands whose Kconfig
> help doesn't match the source.

I tend to agree here. When Holger sent these patches recently I was very
pleased that he has put some love into the Kconfig files. Bit indeed it
is very hard (and unnecessary) work to keep them in sync. Holger, what's
your take on this? Is our new (and yet-to-be-uploaded-to-the-net)
Documentation prominent enough to drop the usage from Kconfig?

Sascha

-- 
Pengutronix e.K.                           |                             |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox