From: Peter Tyser Date: Mon, 08 Sep 2008 12:45:24 -0500 Subject: [U-Boot] [PATCH] cmd_mem.c: Fix help message alignment In-Reply-To: <20080906204515.9A70624815@gemini.denx.de> References: <1219755786-26631-1-git-send-email-wd@denx.de> <1219766722.11226.25.camel@localhost.localdomain> <20080906204515.9A70624815@gemini.denx.de> Message-ID: <1220895924.11226.392.camel@localhost.localdomain> List-Id: MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit To: u-boot@lists.denx.de > > 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. Will do, thanks for the feedback, Peter