[U-Boot] [PATCH] cmd_mem.c: Fix help message alignment

Wolfgang Denk wd at denx.de
Sat Sep 6 22:45:15 CEST 2008


Dear Peter,

In message <1219766722.11226.25.camel at localhost.localdomain> you wrote:
> On Tue, 2008-08-26 at 15:03 +0200, Wolfgang Denk wrote:
> > Bug was introced by "Big white-space cleanup" (53677ef1)
> 
> s/introced/introduced/

Thanks, too late. When I read your message, that commit was already
pushed oout. Sorry.

> What is the preferred command indentation in general?
> 
> - Tabs or spaces? eg:
> "dhcp\t- invoke DHCP client to obtain IP/boot params\n"
> "exit    - exit script\n"

TABs are preferred, as they save  memory  footprint  for  the  U-Boot
image. But for the help textx, this often makes the code hard to read
and difficult to edit, so spaces are accepted here as well.

> - What about commands that exceed the soft limit of 8 characters?  Are
> they acceptable?  Should there be a space between the command and the -?
> eg I currently see both:
> "interrupts - enable or disable interrupts\n"
> "reiserload- load binary file from a Reiser filesystem\n"

Long command names should be avoided  in  general.  If  the  name  is
exactly  8  characters,  so  that the '-' would align without a space
between the name and the '-', then omit it; otherwise add it.

> I'd be happy to post these patches if desired.  If so, I'll wait till I
> hear back about the preferred indentation method.

Well, try and post them; probably on the next merge window.

Best regards,

Wolfgang Denk

-- 
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
Keep your eyes wide open before marriage, half shut afterwards.
                                                 -- Benjamin Franklin


More information about the U-Boot mailing list