diff options
| author | Robert Schwebel <r.schwebel@pengutronix.de> | 2010-12-13 21:28:48 +0100 |
|---|---|---|
| committer | Robert Schwebel <r.schwebel@pengutronix.de> | 2010-12-17 21:28:41 +0100 |
| commit | 91ed5b8729ec9bdd218959319b61af01b640a670 (patch) | |
| tree | 637fe1d5539b59e3ef9bee3e219305bbbfcf7ab8 | |
| parent | 6e0e03cda386eb3674b2004b801f52a7907c4428 (diff) | |
| download | barebox-91ed5b8729ec9bdd218959319b61af01b640a670.tar.gz barebox-91ed5b8729ec9bdd218959319b61af01b640a670.tar.xz | |
doc: add documentation for 'rarpboot' command
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
| -rw-r--r-- | Documentation/commands.dox | 2 | ||||
| -rw-r--r-- | Doxyfile | 3 | ||||
| -rw-r--r-- | commands/net.c | 19 |
3 files changed, 19 insertions, 5 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox index 8895e0e7..7a515c5c 100644 --- a/Documentation/commands.dox +++ b/Documentation/commands.dox @@ -86,7 +86,7 @@ available in @a Barebox: @li @subpage pwd_command @li @subpage readline_command @li @subpage reset_command -@li @subpage rarpboot +@li @subpage rarpboot_command @li @subpage reginfo_command @li @subpage rm_command @li @subpage rmdir_command @@ -1070,7 +1070,8 @@ INCLUDE_FILE_PATTERNS = PREDEFINED = \ DOXYGEN_SHOULD_SKIP_THIS \ CONFIG_CMD_DEVINFO \ - CONFIG_NET_TFTP_PUSH + CONFIG_NET_TFTP_PUSH \ + CONFIG_NET_RARP # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. diff --git a/commands/net.c b/commands/net.c index 938463c7..3adf537b 100644 --- a/commands/net.c +++ b/commands/net.c @@ -38,7 +38,7 @@ #ifdef CONFIG_NET_RARP extern void RarpRequest(void); -static int do_rarpb(struct command *cmdtp, int argc, char *argv[]) +static int do_rarpboot(struct command *cmdtp, int argc, char *argv[]) { int size; @@ -57,11 +57,24 @@ static int do_rarpb(struct command *cmdtp, int argc, char *argv[]) return 0; } +BAREBOX_CMD_HELP_START(rarpboot) +BAREBOX_CMD_HELP_USAGE("rarpboot [LOADADDR] [BOOTFILENAME]\n") +BAREBOX_CMD_HELP_SHORT("Boot an image via network using rarp/tftp protocol.\n") +BAREBOX_CMD_HELP_END + +/** + * @page rarpboot_command + +\todo Discuss this command with sha. The signature looks wrong. + + */ + BAREBOX_CMD_START(rarpboot) - .cmd = do_rarpb, + .cmd = do_rarpboot, .usage = "boot image via network using rarp/tftp protocol", - BAREBOX_CMD_HELP("[loadAddress] [bootfilename]\n") + BAREBOX_CMD_HELP(cmd_rarpboot_help) BAREBOX_CMD_END + #endif /* CONFIG_NET_RARP */ static int do_ethact(struct command *cmdtp, int argc, char *argv[]) |