diff options
author | Robert Schwebel <r.schwebel@pengutronix.de> | 2010-10-31 20:33:50 +0100 |
---|---|---|
committer | Sascha Hauer <s.hauer@pengutronix.de> | 2010-11-01 16:23:09 +0100 |
commit | 681f821d05116c20dcb59cf76d87a5e1b04767bd (patch) | |
tree | d409d6d5da3b4eede8aa1eb2ae9d3fcfe3f423e0 /lib/driver.c | |
parent | 839b210601f09c1e617b4347f8cdc8e47b39f84a (diff) | |
download | barebox-681f821d05116c20dcb59cf76d87a5e1b04767bd.tar.gz barebox-681f821d05116c20dcb59cf76d87a5e1b04767bd.tar.xz |
doc: unify documentation for 'devinfo'
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
Diffstat (limited to 'lib/driver.c')
-rw-r--r-- | lib/driver.c | 44 |
1 files changed, 21 insertions, 23 deletions
diff --git a/lib/driver.c b/lib/driver.c index 62ad88f403..ff92e44d21 100644 --- a/lib/driver.c +++ b/lib/driver.c @@ -264,7 +264,6 @@ void devices_shutdown(void) } #ifdef CONFIG_CMD_DEVINFO - static int do_devinfo_subtree(struct device_d *dev, int depth, char edge) { struct device_d *child; @@ -340,30 +339,22 @@ static int do_devinfo(struct command *cmdtp, int argc, char *argv[]) return 0; } -static const __maybe_unused char cmd_devinfo_help[] = -"Usage: devinfo [DEVICE]\n" -"If called without arguments devinfo shows a summary about known devices and\n" -"drivers. If called with a device path as argument devinfo shows more detailed\n" -"information about this device and its parameters.\n"; +BAREBOX_CMD_HELP_START(devinfo) +BAREBOX_CMD_HELP_USAGE("devinfo [DEVICE]\n") +BAREBOX_CMD_HELP_SHORT("Output device information.\n") +BAREBOX_CMD_HELP_END -BAREBOX_CMD_START(devinfo) - .cmd = do_devinfo, - .usage = "display info about devices and drivers", - BAREBOX_CMD_HELP(cmd_devinfo_help) -BAREBOX_CMD_END +/** + * @page devinfo_command -#endif +If called without arguments, devinfo shows a summary of the known +devices and drivers. + +If called with a device path being the argument, devinfo shows more +default information about this device and its parameters. + +Example from an MPC5200 based system: -/** - * @page devinfo_command devinfo - * - * Usage is: devinfo /dev/\<device> - * - * If called without arguments devinfo shows a summary about known devices and - * drivers. If called with a device path as argument devinfo shows more - * detailed information about this device and its parameters. - * - * Example from an MPC5200 based system: @verbatim barebox:/ devinfo /dev/eth0 base : 0x1002b000 @@ -378,5 +369,12 @@ BAREBOX_CMD_END netmask = 255.255.255.0 serverip = 192.168.23.2 @endverbatim - * */ + +BAREBOX_CMD_START(devinfo) + .cmd = do_devinfo, + .usage = "Show information about devices and drivers.", + BAREBOX_CMD_HELP(cmd_devinfo_help) +BAREBOX_CMD_END +#endif + |