diff options
| author | Robert Schwebel <r.schwebel@pengutronix.de> | 2010-12-13 22:30:26 +0100 |
|---|---|---|
| committer | Robert Schwebel <r.schwebel@pengutronix.de> | 2010-12-17 21:28:42 +0100 |
| commit | 39a585e093b36ad6a2b6c9324d14bc59817f9d6d (patch) | |
| tree | c52d6eb1ba71e99b69d94b36fe86d751468ad900 | |
| parent | 1bce4fa451f1f2881d316441c5cb12a25222a4c4 (diff) | |
| download | barebox-for-mainline-doc.tar.gz barebox-for-mainline-doc.tar.xz | |
doc: add documentation for 'md' commandfor-mainline-doc
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
| -rw-r--r-- | Documentation/commands.dox | 2 | ||||
| -rw-r--r-- | commands/mem.c | 37 |
2 files changed, 21 insertions, 18 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox index 7f5c4f7d..1148e3d0 100644 --- a/Documentation/commands.dox +++ b/Documentation/commands.dox @@ -66,7 +66,7 @@ available in @a Barebox: @li @subpage login @li @subpage ls_command @li @subpage lsmod_command -@li @subpage md +@li @subpage md_command @li @subpage memcmp_command @li @subpage meminfo_command @li @subpage memset diff --git a/commands/mem.c b/commands/mem.c index f9f71a7d..76bfa0a0 100644 --- a/commands/mem.c +++ b/commands/mem.c @@ -212,24 +212,27 @@ out: return errno; } -static const __maybe_unused char cmd_md_help[] = -"Usage md [OPTIONS] <region>\n" -"display (hexdump) a memory region.\n" -"options:\n" -" -s <file> display file (default /dev/mem)\n" -" -b output in bytes\n" -" -w output in halfwords (16bit)\n" -" -l output in words (32bit)\n" -"\n" -"Memory regions:\n" -"Memory regions can be specified in two different forms: start+size\n" -"or start-end, If <start> is ommitted it defaults to 0. If end is ommited it\n" -"defaults to the end of the device, except for interactive commands like md\n" -"and mw for which it defaults to 0x100.\n" -"Sizes can be specified as decimal, or if prefixed with 0x as hexadecimal.\n" -"an optional suffix of k, M or G is for kibibytes, Megabytes or Gigabytes,\n" -"respectively\n"; +BAREBOX_CMD_HELP_START(md) +BAREBOX_CMD_HELP_USAGE("md [OPTIONS] <region>\n") +BAREBOX_CMD_HELP_SHORT("Display (hexdump) a memory region.\n") +BAREBOX_CMD_HELP_OPT ("-s <file>", "display file (default: /dev/mem)\n") +BAREBOX_CMD_HELP_OPT ("-b", "output in bytes\n") +BAREBOX_CMD_HELP_OPT ("-w", "output in halfwords (16 bit)\n") +BAREBOX_CMD_HELP_OPT ("-l", "output in words (32 bit)\n") +BAREBOX_CMD_HELP_END + +/** + * @page md_command + +<p> Memory regions can be specified in two different forms: start+size +or start-end, If <start> is ommitted it defaults to 0. If end is ommited +it defaults to the end of the device, except for interactive commands +like md and mw for which it defaults to 0x100. Sizes can be specified as +decimal, or if prefixed with 0x as hexadecimal. an optional suffix of k, +M or G is for kibibytes, Megabytes or Gigabytes, respectively. </p> + + */ BAREBOX_CMD_START(md) .cmd = do_mem_md, |