diff options
| -rw-r--r-- | Documentation/commands.dox | 14 | ||||
| -rw-r--r-- | Documentation/developers_manual.dox | 1 | ||||
| -rw-r--r-- | arch/architecture.dox | 5 | ||||
| -rw-r--r-- | commands/mount.c | 34 | ||||
| -rw-r--r-- | common/env.c | 17 |
5 files changed, 62 insertions, 9 deletions
diff --git a/Documentation/commands.dox b/Documentation/commands.dox new file mode 100644 index 0000000000..e470972e87 --- /dev/null +++ b/Documentation/commands.dox @@ -0,0 +1,14 @@ +/** + * @page command_reference Supported Shell Commands + + - @subpage cat_command + - @subpage cd_command + - @subpage cp_command + - @subpage printenv_command + - @subpage saveenv_command + - @subpage loadenv_command + - @subpage setenv_command + - @subpage export_command + - @subpage mount_command + +*/ diff --git a/Documentation/developers_manual.dox b/Documentation/developers_manual.dox index 17e5e0faa8..e08c1f905a 100644 --- a/Documentation/developers_manual.dox +++ b/Documentation/developers_manual.dox @@ -7,4 +7,5 @@ FIXME: Hints and tips for simply adapting UBootv2 - @subpage dev_architecture - @subpage dev_params +@subpage how_mount_works */
\ No newline at end of file diff --git a/arch/architecture.dox b/arch/architecture.dox index 1e5d675a29..85cff53ed7 100644 --- a/arch/architecture.dox +++ b/arch/architecture.dox @@ -6,7 +6,10 @@ Friesel /** @page dev_cpu Intergrate a new CPU (MACH) -Frasel +Features required for every CPU: + + - clocksource + - CPU reset function - @subpage dev_arm_mach - @subpage dev_bf_mach diff --git a/commands/mount.c b/commands/mount.c index ec27d10c80..db47be724c 100644 --- a/commands/mount.c +++ b/commands/mount.c @@ -20,6 +20,11 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ +/** + * @file + * @brief Filesystem mounting support + */ + #include <common.h> #include <command.h> #include <fs.h> @@ -73,3 +78,32 @@ U_BOOT_CMD_START(mount) .usage = "mount a filesystem to a device", U_BOOT_CMD_HELP(cmd_mount_help) U_BOOT_CMD_END + +/** @page mount_command mount + * Usage: mount [<device> <fstype> <mountpoint>] + * + * Mounts a filesystem of a given <fstype> on a <device> to a <mountpoint>. + * <device> can be one of /dev/* or some arbitrary string if no + * device is needed for this driver (for example ramfs). + * + * <fstype> is the filesystem driver to use. Try the 'devinfo' command + * for a list of available drivers. + * + * <mountpoint> must be an empty directory descending directly from the + * root directory. + */ + +/** @page how_mount_works How mount works in UBoot + * + * Mounting a filesystem ontop of a device is working like devices and drivers + * are finding together. + * + * The mount command creates a new device with the filesystem name as the + * driver for this "device". So the framework is able to merge both parts + * together. + * + * By the way: With this feature its impossible to accidentely remove + * partitions in use. A partition is internally also a device. If its mounted + * it will be marked as busy, so an delpart command fails, until the filesystem + * has been unmounted. + */ diff --git a/common/env.c b/common/env.c index 1b092c94fe..c8cb29a7a3 100644 --- a/common/env.c +++ b/common/env.c @@ -337,22 +337,24 @@ U_BOOT_CMD_START(setenv) "setenv name\n" " - delete environment variable 'name'\n") U_BOOT_CMD_END +#endif /** * @page setenv_command setenv * - * Usage: setenv <name> [<value>] + * 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 <value ...> - * If no <value> was given, the variable <name> will be removed. + * This command can be replaced by using the simpler form in the hush: * - * This command can be replaced by using the simpler form: + * <name> = <val> * - * <name> = <value> + * @note This command is only required if the simple + * parser (not the hush) is in use. */ -#endif - static int do_export ( cmd_tbl_t *cmdtp, int argc, char *argv[]) { int i = 1; @@ -396,4 +398,3 @@ U_BOOT_CMD_END * * Export an environment variable to subsequently executed scripts */ - |