Patchwork [U-Boot,v3,3/3] SPL: Change description for spl command

login
register
mail settings
Submitter Stefano Babic
Date Nov. 19, 2012, 9:11 a.m.
Message ID <1353316265-24430-3-git-send-email-sbabic@denx.de>
Download mbox | patch
Permalink /patch/199955/
State Superseded
Delegated to: Tom Rini
Headers show

Comments

Stefano Babic - Nov. 19, 2012, 9:11 a.m.
Add a more descriptive text to the help of the spl
command.

Signed-off-by: Stefano Babic <sbabic@denx.de>
---

 common/cmd_spl.c |   12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)
Andreas Bießmann - Nov. 19, 2012, 10:17 a.m.
Dear Stefano Babic,

On 19.11.2012 10:11, Stefano Babic wrote:
> Add a more descriptive text to the help of the spl
> command.
> 
> Signed-off-by: Stefano Babic <sbabic@denx.de>
> ---
> 
>  common/cmd_spl.c |   12 ++++++++----
>  1 file changed, 8 insertions(+), 4 deletions(-)
> 
> diff --git a/common/cmd_spl.c b/common/cmd_spl.c
> index 9ec054a..b21d41d 100644
> --- a/common/cmd_spl.c
> +++ b/common/cmd_spl.c
> @@ -182,7 +182,11 @@ static int do_spl(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
>  
>  U_BOOT_CMD(
>  	spl, 6 , 1, do_spl, "SPL configuration",
> -	"export <img=atags|fdt> [kernel_addr] [initrd_addr] "
> -	"[fdt_addr if <img> = fdt] - export a kernel parameter image\n"
> -	"\t initrd_img can be set to \"-\" if fdt_addr without initrd img is"
> -	"used");
> +	"export <img=atags|fdt> [kernel_addr] [initrd_addr] [fdt_addr ]\n"
---------------------------------------------------------------------^
unnecessary blank

> +	"\timg\t\t\"atags\" or \"fdt\"\n"
> +	"\tkernel_addr\taddress where a kernel image is stored.\n"
> +	"\t\t\tkernel is loaded as part of the boot process, but it is not started.\n"
> +	"\tinitrd_addr\tAddress of initial ramdisk\n"
------------------------^
Capitalization should be uniform. Either change all other places to
capital beginning or start here with small letters.

> +	"\t\t\tcan be set to \"-\" if fdt_addr without initrd img is used\n"
--------------------------------------------------------------^
I think we should write here either 'initrd image'/'initial ramdisk
image' or 'initrd_addr'. I know img is a well known abbreviation for
image, but in a descriptive text we should IMHO not abbreviate.
Additionally the sentence should stop with a full stop like the others do.

> +	"\tfdt_addr\tin case of fdt, the address of the device tree.\n"
> +	);
> 

Best regards

Andreas Bießmann

Patch

diff --git a/common/cmd_spl.c b/common/cmd_spl.c
index 9ec054a..b21d41d 100644
--- a/common/cmd_spl.c
+++ b/common/cmd_spl.c
@@ -182,7 +182,11 @@  static int do_spl(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 
 U_BOOT_CMD(
 	spl, 6 , 1, do_spl, "SPL configuration",
-	"export <img=atags|fdt> [kernel_addr] [initrd_addr] "
-	"[fdt_addr if <img> = fdt] - export a kernel parameter image\n"
-	"\t initrd_img can be set to \"-\" if fdt_addr without initrd img is"
-	"used");
+	"export <img=atags|fdt> [kernel_addr] [initrd_addr] [fdt_addr ]\n"
+	"\timg\t\t\"atags\" or \"fdt\"\n"
+	"\tkernel_addr\taddress where a kernel image is stored.\n"
+	"\t\t\tkernel is loaded as part of the boot process, but it is not started.\n"
+	"\tinitrd_addr\tAddress of initial ramdisk\n"
+	"\t\t\tcan be set to \"-\" if fdt_addr without initrd img is used\n"
+	"\tfdt_addr\tin case of fdt, the address of the device tree.\n"
+	);