summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--Documentation/users_manual.dox2
-rw-r--r--Doxyfile5
-rw-r--r--board/board.dox2
-rw-r--r--common/hush.c44
-rw-r--r--lib/readline_simple.c16
5 files changed, 46 insertions, 23 deletions
diff --git a/Documentation/users_manual.dox b/Documentation/users_manual.dox
index aeb79883c8..58f87a0b45 100644
--- a/Documentation/users_manual.dox
+++ b/Documentation/users_manual.dox
@@ -2,7 +2,9 @@
FIXME: Hints and tips for simply using UBootv2
+
- @subpage shell_notes
+ - @subpage readline_parser
- @subpage command_reference
- @subpage partitions
diff --git a/Doxyfile b/Doxyfile
index e8dfdea862..48dcb72fd4 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -465,7 +465,8 @@ INPUT = Documentation \
drivers \
commands \
common \
- board
+ board \
+ lib
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -1240,7 +1241,7 @@ DOT_MULTI_TARGETS = NO
# generate a legend page explaining the meaning of the various boxes and
# arrows in the dot generated graphs.
-GENERATE_LEGEND = YES
+GENERATE_LEGEND = NO
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
# remove the intermediate dot files that are used to generate
diff --git a/board/board.dox b/board/board.dox
index a68a96aed1..390a6c2f8c 100644
--- a/board/board.dox
+++ b/board/board.dox
@@ -1,4 +1,4 @@
-/** @page dev_board Intergrating a new board
+/** @page dev_board Integrating a new Board
Blablubb
diff --git a/common/hush.c b/common/hush.c
index f6d4133eab..d85f85718f 100644
--- a/common/hush.c
+++ b/common/hush.c
@@ -25,26 +25,6 @@
* miscellaneous bugfixes from Matt Kraai
*/
-/**
- * @file
- * @brief A prototype Bourne shell grammar parser
- */
-
-/** @page sh_command Starting shell
- *
- * Usage: sh <filename> [<arguments>]
- *
- * Execute a shell script named <filename> and forward (if given)
- * <arguments> to it.
- *
- * 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
- * command executed from filename.
- */
-
/** @page shell_notes Simple Shell Environment: Hush
*
* @par Notes from the source:
@@ -108,6 +88,10 @@
*
* - redirecting (stdout to a file for example)
* - recursion
+ *
+ * Enable the "Hush parser" in "General Settings", "Select your shell" to
+ * get the new console feeling.
+ *
*/
/*
@@ -1582,3 +1566,23 @@ U_BOOT_CMD_START(source)
.usage = "execute shell script in current shell environment",
U_BOOT_CMD_HELP(cmd_source_help)
U_BOOT_CMD_END
+
+/**
+ * @file
+ * @brief A prototype Bourne shell grammar parser
+ */
+
+/** @page sh_command Starting shell
+ *
+ * Usage: sh <filename> [<arguments>]
+ *
+ * Execute a shell script named <filename> and forward (if given)
+ * <arguments> to it.
+ *
+ * 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
+ * command executed from filename.
+ */
diff --git a/lib/readline_simple.c b/lib/readline_simple.c
index 8a6eb816df..b1ac64a545 100644
--- a/lib/readline_simple.c
+++ b/lib/readline_simple.c
@@ -140,3 +140,19 @@ int readline (const char *prompt, char *line, int len)
}
}
}
+
+/**
+ * @file
+ * @brief Primitiv Line Parser
+ */
+
+/** @page readline_parser Primitive Line Parser
+ *
+ * There is still a primtive line parser as a alternative to the hush shell
+ * environment available. This is for persons who like the old fashion way of
+ * edititing and command entering.
+ *
+ * Enable the "Simple parser" in "General Settings", "Select your shell" to
+ * get back the old console feeling.
+ *
+ */ \ No newline at end of file