summaryrefslogtreecommitdiffstats
path: root/common
diff options
context:
space:
mode:
authorJuergen Beisert <j.beisert@pengutronix.de>2007-11-08 12:01:52 +0100
committerJuergen Beisert <j.beisert@pengutronix.de>2007-11-08 12:01:52 +0100
commit8fe25ecf1270ab08e0b3baf5e8bae91e8f55eaa9 (patch)
treee7688eb0e6b8a5c8aba5c810719d41888c7de926 /common
parent0a13be8de25ea2ba37f156fbfac0555125f651f3 (diff)
downloadbarebox-8fe25ecf1270ab08e0b3baf5e8bae91e8f55eaa9.tar.gz
barebox-8fe25ecf1270ab08e0b3baf5e8bae91e8f55eaa9.tar.xz
adding various doku
Diffstat (limited to 'common')
-rw-r--r--common/env.c18
-rw-r--r--common/hush.c14
2 files changed, 16 insertions, 16 deletions
diff --git a/common/env.c b/common/env.c
index 98789e0206..96a8ed035b 100644
--- a/common/env.c
+++ b/common/env.c
@@ -306,12 +306,12 @@ U_BOOT_CMD_END
/**
* @page printenv_command printenv
*
- * Usage: printenv [<name>]
+ * Usage: printenv [\<name>]
*
* Print environment variables.
- * If <name> was given, it prints out its content if the environment variable
- * <name> exists.
- * Without the <name> argument all current environment variables are printed.
+ * If \<name> was given, it prints out its content if the environment variable
+ * \<name> exists.
+ * Without the \<name> argument all current environment variables are printed.
*/
#ifdef CONFIG_SIMPLE_PARSER
@@ -342,14 +342,14 @@ U_BOOT_CMD_END
/**
* @page setenv_command setenv
*
- * Usage: setenv <name> [<val>]
+ * Usage: setenv \<name> [\<val>]
*
- * Set environment variable <name> to <val ...>
- * If no <val> was given, the variable <name> will be removed.
+ * Set environment variable \<name> to \<val ...>
+ * If no \<val> was given, the variable \<name> will be removed.
*
* This command can be replaced by using the simpler form in the hush:
*
- * <name> = <val>
+ * \<name> = \<val>
*
* @note This command is only required if the simple
* parser (not the hush) is in use.
@@ -394,7 +394,7 @@ U_BOOT_CMD_END
/**
* @page export_command export
*
- * Usage: export <var>[=value]...
+ * Usage: export \<var>[=value]...
*
* Export an environment variable to subsequently executed scripts
*/
diff --git a/common/hush.c b/common/hush.c
index d85f85718f..c05b5642b7 100644
--- a/common/hush.c
+++ b/common/hush.c
@@ -1574,15 +1574,15 @@ U_BOOT_CMD_END
/** @page sh_command Starting shell
*
- * Usage: sh <filename> [<arguments>]
+ * Usage: sh \<filename\> [\<arguments\>]
*
- * Execute a shell script named <filename> and forward (if given)
- * <arguments> to it.
+ * Execute a shell script named \<filename\> and forward (if given)
+ * \<arguments\> to it.
*
- * Usage: . <filename> [<arguments>]
- * or source <filename> [<arguments>]
+ * Usage: . \<filename\> [\<arguments\>]
+ * or source \<filename\> [\<arguments\>]
*
- * Read and execute commands from <filename> in the current shell environment,
- * forward (if given) <arguments> to it and return the exit status of the last
+ * Read and execute commands from \<filename\> in the current shell environment,
+ * forward (if given) \<arguments\> to it and return the exit status of the last
* command executed from filename.
*/