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.

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================