summaryrefslogtreecommitdiffstats
path: root/net
diff options
context:
space:
mode:
authorSascha Hauer <s.hauer@pengutronix.de>2010-06-15 11:49:19 +0200
committerSascha Hauer <s.hauer@pengutronix.de>2010-06-28 10:45:25 +0200
commit38d862f68731ef204aaad906cecb049882db7c05 (patch)
tree22f39822844d37c39dcdbb12c8e314f3a41f5cf9 /net
parentb3c91fbf5fcfb6d9b022bce8727abadb93266c1f (diff)
downloadbarebox-38d862f68731ef204aaad906cecb049882db7c05.tar.gz
barebox-38d862f68731ef204aaad906cecb049882db7c05.tar.xz
tftp: update doxygen information
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'net')
-rw-r--r--net/tftp.c21
1 files changed, 13 insertions, 8 deletions
diff --git a/net/tftp.c b/net/tftp.c
index e6a2027384..6345a7220d 100644
--- a/net/tftp.c
+++ b/net/tftp.c
@@ -387,16 +387,21 @@ BAREBOX_CMD_END
/**
* @page tftp_command tftp
*
- * Usage is: tftp \<filename\> [\<localfilename\>]
+ * Usage:
+ * tftp \<remotefilename\> [\<localfilename\>]
*
- * Load a file via network using BootP/TFTP protocol. The loaded file you
- * can find after download in you current ramdisk. Refer \b ls command.
+ * or
*
- * \<localfile> can be the local filename only, or also a device name. In the
- * case of a device name, the will gets stored there. This works also for
- * partitions of flash memory. Refer \b erase, \b unprotect for flash
- * preparation.
+ * tftp -p \<localfilename\> [\<remotefilename\>]
*
- * Note: This command is available only, if enabled in the menuconfig.
+ * Load a file from a tftp server or upload a file to a tftp server if
+ * the -p option is given. The second file argument can be skipped in
+ * which case the first filename is used (without the directory part).
+ *
+ * \<localfile> can be the local filename or a device file under /dev.
+ * This also works for flash memory. Refer to \b erase, \b unprotect for
+ * flash preparation.
+ *
+ * Note: This command is available only if enabled in menuconfig.
*/