summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobert Schwebel <r.schwebel@pengutronix.de>2010-12-13 21:19:58 +0100
committerRobert Schwebel <r.schwebel@pengutronix.de>2010-12-17 21:28:41 +0100
commit6e0e03cda386eb3674b2004b801f52a7907c4428 (patch)
tree048797d8dabb7a468ecfd241c01de65dfa685c21
parentdcff25c26aee79135b67190ca95b1a912c8b74aa (diff)
downloadbarebox-6e0e03cda386eb3674b2004b801f52a7907c4428.tar.gz
barebox-6e0e03cda386eb3674b2004b801f52a7907c4428.tar.xz
doc: add documentation for 'nfs' command
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
-rw-r--r--Documentation/commands.dox2
-rw-r--r--net/nfs.c14
2 files changed, 12 insertions, 4 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 9638728a..8895e0e7 100644
--- a/Documentation/commands.dox
+++ b/Documentation/commands.dox
@@ -78,7 +78,7 @@ available in @a Barebox:
@li @subpage mycdev
@li @subpage nand
@li @subpage nand_boot_test
-@li @subpage nfs
+@li @subpage nfs_command
@li @subpage passwd
@li @subpage ping_command
@li @subpage printenv_command
diff --git a/net/nfs.c b/net/nfs.c
index 4ca1d6e5..d8e0bccd 100644
--- a/net/nfs.c
+++ b/net/nfs.c
@@ -725,9 +725,17 @@ err_udp:
return nfs_err == 0 ? 0 : 1;
}
-static const __maybe_unused char cmd_nfs_help[] =
-"Usage: nfs <file> [localfile]\n"
-"Load a file via network using nfs protocol.\n";
+BAREBOX_CMD_HELP_START(nfs)
+BAREBOX_CMD_HELP_USAGE("nfs FILE [LOCALFILE]\n")
+BAREBOX_CMD_HELP_SHORT("Load a file via network, using the NFS protocol.\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page nfs_command
+
+\todo Add more details and examples.
+
+ */
BAREBOX_CMD_START(nfs)
.cmd = do_nfs,