9
0
Fork 0

adding new doc

This commit is contained in:
Juergen Beisert 2007-10-19 15:23:48 +02:00
parent 15a794bd70
commit 53dd8423a5
5 changed files with 62 additions and 9 deletions

View File

@ -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
*/

View File

@ -7,4 +7,5 @@ FIXME: Hints and tips for simply adapting UBootv2
- @subpage dev_architecture
- @subpage dev_params
@subpage how_mount_works
*/

View File

@ -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

View File

@ -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.
*/

View File

@ -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 <value ...>
* If no <value> 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:
* This command can be replaced by using the simpler form in the hush:
*
* <name> = <value>
* <name> = <val>
*
* @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
*/