summaryrefslogtreecommitdiffstats
path: root/commands/loadenv.c
diff options
context:
space:
mode:
authorRobert Schwebel <r.schwebel@pengutronix.de>2010-11-01 17:09:34 +0100
committerRobert Schwebel <r.schwebel@pengutronix.de>2010-11-02 14:07:32 +0100
commitab554d1d41c7fa0bd5d11ef4e62593221dbab474 (patch)
treedc6dd4ccf3b3bb7442d7d04fe01d21b86e28e255 /commands/loadenv.c
parent97cd05ca25904c0344617adf191c76a4feac10ea (diff)
downloadbarebox-ab554d1d41c7fa0bd5d11ef4e62593221dbab474.tar.gz
doc: unify documentation for 'loadenv'
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
Diffstat (limited to 'commands/loadenv.c')
-rw-r--r--commands/loadenv.c34
1 files changed, 14 insertions, 20 deletions
diff --git a/commands/loadenv.c b/commands/loadenv.c
index 14fbf1e..c33c34f 100644
--- a/commands/loadenv.c
+++ b/commands/loadenv.c
@@ -43,28 +43,22 @@ static int do_loadenv(struct command *cmdtp, int argc, char *argv[])
return envfs_load(filename, dirname);
}
-static const __maybe_unused char cmd_loadenv_help[] =
-"Usage: loadenv [ENVFS] [DIRECTORY]\n"
-"Load the persistent storage contained in <envfs> to the directory\n"
-"<directory>.\n"
-"If ommitted <directory> defaults to /env and <envfs> defaults to /dev/env0.\n"
-"Note that envfs can only handle files. Directories are skipped silently.\n";
+BAREBOX_CMD_HELP_START(loadenv)
+BAREBOX_CMD_HELP_USAGE("loadenv [ENVFS] [DIRECTORY]\n")
+BAREBOX_CMD_HELP_SHORT("Load environment from ENVFS into DIRECTORY (default: /dev/env0 -> /env).\n")
+BAREBOX_CMD_HELP_END
+
+/**
+ * @page loadenv_command
+
+ENVFS can only handle files, directories are skipped silently.
+
+\todo This needs proper documentation. What is ENVFS, why is it FS etc. Explain the concepts.
+
+ */
BAREBOX_CMD_START(loadenv)
.cmd = do_loadenv,
- .usage = "load environment from persistent storage",
+ .usage = "Load environment from ENVFS into DIRECTORY (default: /dev/env0 -> /env).",
BAREBOX_CMD_HELP(cmd_loadenv_help)
BAREBOX_CMD_END
-
-/**
- * @page loadenv_command loadenv
- *
- * Usage: loadenv [\<directory>] [\<envfs>]
- *
- * Load the persistent storage contained in \<envfs> to the directory \<directory>.
- *
- * If ommitted \<directory> defaults to \c /env and \<envfs> defaults to
- * \c /dev/env0.
- *
- * @note envfs can only handle files. Directories are skipped silently.
- */