mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Jean-Christophe PLAGNIOL-VILLARD <plagnioj@jcrosoft.com>
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 20:09:53 +0200	[thread overview]
Message-ID: <20140707180953.GF15426@ns203013.ovh.net> (raw)
In-Reply-To: <alpine.LFD.2.11.1407070505420.27781@localhost>

On 05:11 Mon 07 Jul     , 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
> 
> ... snip ...
> 
>   i'd have to agree ... there's quite a lot of help info that's out of
> sync between the Kconfig entries and the source file entries. for
> example, check out the Kconfig entry for the "boot" command:
> 
> config CMD_BOOT
>         tristate
>         select BOOTM
>         prompt "boot"
>         help
>         ... snip ...
>           Options:
>               -c         crc check uImage data
>               -d         dryrun: check data, but do not run
>               -f         load images even if type is undetectable
>               -r INITRD  specify an initrd image
>               -L ADDR    specify initrd load address
>               -a ADDR    specify os load address
>               -e OFFS    entry point to the image relative to start (0)
>               -o DTS     specify open firmware device tree
>               -v         verbose
> 
> versus what's in the command source file:
> 
> BAREBOX_CMD_HELP_TEXT("Options:")
> BAREBOX_CMD_HELP_OPT ("-v","Increase verbosity")
> BAREBOX_CMD_HELP_OPT ("-d","Dryrun. See what happens but do no actually boot")
> BAREBOX_CMD_HELP_OPT ("-l","List available boot sources")
> BAREBOX_CMD_HELP_OPT ("-m","Show a menu with boot options")
> BAREBOX_CMD_HELP_OPT ("-t SECS","specify timeout in SECS")
> BAREBOX_CMD_HELP_END
> 
> and there are quite a few other examples of mismatches like that.

So we should simply drop them from Kconfig

Best Regards,
J.
> 
> rday
> 
> -- 
> 
> ========================================================================
> Robert P. J. Day                                 Ottawa, Ontario, CANADA
>                         http://crashcourse.ca
> 
> Twitter:                                       http://twitter.com/rpjday
> LinkedIn:                               http://ca.linkedin.com/in/rpjday
> ========================================================================


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

  reply	other threads:[~2014-07-07 18:06 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-07-04 16:18 Robert P. J. Day
2014-07-07  6:35 ` Sascha Hauer
2014-07-07  6:39 ` Jean-Christophe PLAGNIOL-VILLARD
2014-07-07  9:11   ` Robert P. J. Day
2014-07-07 18:09     ` Jean-Christophe PLAGNIOL-VILLARD [this message]
2014-07-07 21:10       ` Holger Schurig
2014-07-07 10:07   ` Robert P. J. Day
2014-07-07 12:07     ` Sascha Hauer
2014-07-07 21:11       ` Holger Schurig

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=20140707180953.GF15426@ns203013.ovh.net \
    --to=plagnioj@jcrosoft.com \
    --cc=barebox@lists.infradead.org \
    --cc=rpjday@crashcourse.ca \
    /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