summaryrefslogtreecommitdiffstats
path: root/commands/environment.c
diff options
context:
space:
mode:
authorJuergen Beisert <jbe@isonoe.(none)>2007-10-19 14:56:45 +0200
committerJuergen Beisert <jbe@isonoe.(none)>2007-10-19 14:56:45 +0200
commitafe73cff56de417ce21096476928f53a7515ddec (patch)
treeca75b8b93cc2b4b69fc9923162ea7c80d5ff3d2a /commands/environment.c
parent18690c9c23d424f5a28d24f4369533745c4ddbb3 (diff)
downloadbarebox-afe73cff56de417ce21096476928f53a7515ddec.tar.gz
barebox-afe73cff56de417ce21096476928f53a7515ddec.tar.xz
doc added and some reorganised
Diffstat (limited to 'commands/environment.c')
-rw-r--r--commands/environment.c34
1 files changed, 33 insertions, 1 deletions
diff --git a/commands/environment.c b/commands/environment.c
index 999a5f3fb4..b5517aa977 100644
--- a/commands/environment.c
+++ b/commands/environment.c
@@ -20,6 +20,11 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/**
+ * @file
+ * @brief Managing environment and environment variables
+ */
+
#ifdef __U_BOOT__
#include <common.h>
#include <command.h>
@@ -205,7 +210,7 @@ out:
}
static __maybe_unused char cmd_saveenv_help[] =
-"Usage: saveenv [DIRECTORY] [ENVFS]\n"
+"Usage: saveenv [<envfs>] [<directory>]\n"
"Save the files in <directory> to the persistent storage device <envfs>.\n"
"<envfs> is normally a block in flash, but could be any other file.\n"
"If ommitted <directory> defaults to /env and <envfs> defaults to /dev/env0.\n"
@@ -219,6 +224,20 @@ U_BOOT_CMD_START(saveenv)
U_BOOT_CMD_END
#endif /* __U_BOOT__ */
+/**
+ * @page saveenv_command saveenv
+ *
+ * Usage: saveenv [<envfs>] [<directory>]
+ *
+ * Save the files in <directory> to the persistent storage device <envfs>.
+ * <envfs> is normally a block in flash, but could be any other file.
+ *
+ * If ommitted <directory> defaults to /env and <envfs> defaults to
+ * /dev/env0.
+ *
+ * @note envfs can only handle files. Directories are skipped silently.
+ */
+
int envfs_load(char *filename, char *dir)
{
struct envfs_super super;
@@ -349,3 +368,16 @@ U_BOOT_CMD_START(loadenv)
U_BOOT_CMD_HELP(cmd_loadenv_help)
U_BOOT_CMD_END
#endif /* __U_BOOT__ */
+
+/**
+ * @page loadenv_command loadenv
+ *
+ * Usage: loadenv [<directory>] [<envfs>]
+ *
+ * Load the persistent storage contained in <envfs> to the directory <directory>.
+ *
+ * If ommitted <directory> defaults to /env and <envfs> defaults to
+ * /dev/env0.
+ *
+ * @note envfs can only handle files. Directories are skipped silently.
+ */