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

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

[Robert P. J. Day]

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

diff --git a/commands/of_dump.c b/commands/of_dump.c
index e341942..cafde07 100644
--- a/commands/of_dump.c
+++ b/commands/of_dump.c
@@ -101,7 +101,7 @@ BAREBOX_CMD_HELP_END
 BAREBOX_CMD_START(of_dump)
 	.cmd		= do_of_dump,
 	BAREBOX_CMD_DESC("dump devicetree nodes")
-	BAREBOX_CMD_OPTS("[-f]")
+	BAREBOX_CMD_OPTS("[-f] [NODE]")
 	BAREBOX_CMD_GROUP(CMD_GRP_MISC)
 	BAREBOX_CMD_COMPLETE(devicetree_file_complete)
 	BAREBOX_CMD_HELP(cmd_of_dump_help)
diff --git a/commands/oftree.c b/commands/oftree.c
index a3b0e04..983a0a5 100644
--- a/commands/oftree.c
+++ b/commands/oftree.c
@@ -145,7 +145,7 @@ BAREBOX_CMD_HELP_END
 BAREBOX_CMD_START(oftree)
 	.cmd		= do_oftree,
 	BAREBOX_CMD_DESC("handle device trees")
-	BAREBOX_CMD_OPTS("[-lpfs]")
+	BAREBOX_CMD_OPTS("[-lspf]")
 	BAREBOX_CMD_GROUP(CMD_GRP_MISC)
 	BAREBOX_CMD_HELP(cmd_oftree_help)
 BAREBOX_CMD_END

-- 

========================================================================
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

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

[Sascha Hauer]

On Fri, Jul 04, 2014 at 12:18:42PM -0400, Robert P. J. Day 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.

Looks all good. Applied, thanks

Sascha

> 
> 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
> 
> diff --git a/commands/of_dump.c b/commands/of_dump.c
> index e341942..cafde07 100644
> --- a/commands/of_dump.c
> +++ b/commands/of_dump.c
> @@ -101,7 +101,7 @@ BAREBOX_CMD_HELP_END
>  BAREBOX_CMD_START(of_dump)
>  	.cmd		= do_of_dump,
>  	BAREBOX_CMD_DESC("dump devicetree nodes")
> -	BAREBOX_CMD_OPTS("[-f]")
> +	BAREBOX_CMD_OPTS("[-f] [NODE]")
>  	BAREBOX_CMD_GROUP(CMD_GRP_MISC)
>  	BAREBOX_CMD_COMPLETE(devicetree_file_complete)
>  	BAREBOX_CMD_HELP(cmd_of_dump_help)
> diff --git a/commands/oftree.c b/commands/oftree.c
> index a3b0e04..983a0a5 100644
> --- a/commands/oftree.c
> +++ b/commands/oftree.c
> @@ -145,7 +145,7 @@ BAREBOX_CMD_HELP_END
>  BAREBOX_CMD_START(oftree)
>  	.cmd		= do_oftree,
>  	BAREBOX_CMD_DESC("handle device trees")
> -	BAREBOX_CMD_OPTS("[-lpfs]")
> +	BAREBOX_CMD_OPTS("[-lspf]")
>  	BAREBOX_CMD_GROUP(CMD_GRP_MISC)
>  	BAREBOX_CMD_HELP(cmd_oftree_help)
>  BAREBOX_CMD_END
> 
> -- 
> 
> ========================================================================
> 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
> 

-- 
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

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

[Jean-Christophe PLAGNIOL-VILLARD]

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


> diff --git a/commands/of_dump.c b/commands/of_dump.c
> index e341942..cafde07 100644
> --- a/commands/of_dump.c
> +++ b/commands/of_dump.c
> @@ -101,7 +101,7 @@ BAREBOX_CMD_HELP_END
> BAREBOX_CMD_START(of_dump)
> 	.cmd		= do_of_dump,
> 	BAREBOX_CMD_DESC("dump devicetree nodes")
> -	BAREBOX_CMD_OPTS("[-f]")
> +	BAREBOX_CMD_OPTS("[-f] [NODE]")
> 	BAREBOX_CMD_GROUP(CMD_GRP_MISC)
> 	BAREBOX_CMD_COMPLETE(devicetree_file_complete)
> 	BAREBOX_CMD_HELP(cmd_of_dump_help)
> diff --git a/commands/oftree.c b/commands/oftree.c
> index a3b0e04..983a0a5 100644
> --- a/commands/oftree.c
> +++ b/commands/oftree.c
> @@ -145,7 +145,7 @@ BAREBOX_CMD_HELP_END
> BAREBOX_CMD_START(oftree)
> 	.cmd		= do_oftree,
> 	BAREBOX_CMD_DESC("handle device trees")
> -	BAREBOX_CMD_OPTS("[-lpfs]")
> +	BAREBOX_CMD_OPTS("[-lspf]")
> 	BAREBOX_CMD_GROUP(CMD_GRP_MISC)
> 	BAREBOX_CMD_HELP(cmd_oftree_help)
> BAREBOX_CMD_END
> 
> -- 
> 
> ========================================================================
> 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


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

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

[Robert P. J. Day]

[-- Attachment #1: Type: TEXT/PLAIN, Size: 2744 bytes --]

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
========================================================================

[-- Attachment #2: Type: text/plain, Size: 149 bytes --]

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

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

[Robert P. J. Day]

[-- Attachment #1: Type: TEXT/PLAIN, Size: 1716 bytes --]

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.

rday

-- 

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

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

[-- Attachment #2: Type: text/plain, Size: 149 bytes --]

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

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

[Sascha Hauer]

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

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

[Jean-Christophe PLAGNIOL-VILLARD]

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

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

[Holger Schurig]

> 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?

In the long run, I'd like to put a help on all Kconfig entries.

When I was new to Barebox, and started "make xconfig" and was
partially pleased (because make xconfig worked), but also puzzled,
because so many Kconfig entries did not contain any help text. It was
not easy for me to decide if I need an option or not, or if that
option would just be a nice-to-have one.

From that point of view I like the helps on the commands. They give
you all the info you need to immediately knoy if you want to put a
check there --- or not.

However, Kconfig files are relatively easy to parse (or to write). So
we could declare one option as the "main" source and write a python
program that reads the main source and generates the others out of it.
It's probably me who should write that ...   grin.

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

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

[Holger Schurig]

> Is our new (and yet-to-be-uploaded-to-the-net)
> Documentation prominent enough to drop the usage from Kconfig?

I don't think so. I cannot see that someone has xconfig option, and at
the same time the just alphebetically sorted new html documentation
...  that's cumbersome, isn't it?

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