[PATCH 28/34] doc: add documentation for 'nfs' command
Robert Schwebel
r.schwebel at pengutronix.de
Wed Dec 15 06:51:42 EST 2010
Signed-off-by: Robert Schwebel <r.schwebel at pengutronix.de>
---
Documentation/commands.dox | 2 +-
net/nfs.c | 14 +++++++++++---
2 files changed, 12 insertions(+), 4 deletions(-)
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
index 9638728..8895e0e 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
- at li @subpage nfs
+ at 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 4ca1d6e..d8e0bcc 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,
--
1.7.2.3
More information about the barebox
mailing list