From 98360be0fefd58bf27df03c47d887dd676a31d73 Mon Sep 17 00:00:00 2001 From: Sascha Hauer Date: Tue, 17 Jun 2014 10:27:03 +0200 Subject: Documentation: remove doxygen documentation The doxygen documentation is long outdated. Remove it. It will be replaced with sphinx based documentation later. Signed-off-by: Sascha Hauer --- commands/bootm.c | 17 -------------- commands/cp.c | 14 ----------- commands/devinfo.c | 28 ---------------------- commands/dfu.c | 10 -------- commands/echo.c | 8 ------- commands/edit.c | 16 ------------- commands/flash.c | 52 ----------------------------------------- commands/gpio.c | 62 ------------------------------------------------ commands/led.c | 9 ------- commands/linux16.c | 66 ---------------------------------------------------- commands/loadenv.c | 9 ------- commands/miitool.c | 6 ----- commands/mount.c | 36 ---------------------------- commands/partition.c | 24 ------------------- commands/printenv.c | 14 ----------- commands/saveenv.c | 18 -------------- commands/setenv.c | 13 ----------- commands/splash.c | 11 --------- commands/usbserial.c | 4 ---- 19 files changed, 417 deletions(-) (limited to 'commands') diff --git a/commands/bootm.c b/commands/bootm.c index d6625df460..617acd6169 100644 --- a/commands/bootm.c +++ b/commands/bootm.c @@ -194,20 +194,3 @@ static int binfmt_uimage_init(void) return binfmt_register(&binfmt_uimage_hook); } fs_initcall(binfmt_uimage_init); - -/** - * @file - * @brief Boot support for Linux - */ - -/** - * @page boot_preparation Preparing for Boot - * - * This chapter describes what's to be done to forward the control from - * barebox to Linux. This part describes the generic part, below you can find - * the architecture specific part. - * - * - @subpage arm_boot_preparation - * - @subpage ppc_boot_preparation - * - @subpage x86_boot_preparation - */ diff --git a/commands/cp.c b/commands/cp.c index 8ecde9101f..1a5675405e 100644 --- a/commands/cp.c +++ b/commands/cp.c @@ -17,10 +17,6 @@ * */ -/** - * @file - * @brief cp: copy file command - */ #include #include #include @@ -95,15 +91,6 @@ BAREBOX_CMD_HELP_TEXT("Options:") BAREBOX_CMD_HELP_OPT ("-v", "verbose") BAREBOX_CMD_HELP_END -/** - * @page cp_command -This command operates on files. - -If you want to copy between memory blocks, use 'memcpy'. - -\todo What does this mean? Add examples. - */ - BAREBOX_CMD_START(cp) .cmd = do_cp, BAREBOX_CMD_DESC("copy files") @@ -111,4 +98,3 @@ BAREBOX_CMD_START(cp) BAREBOX_CMD_GROUP(CMD_GRP_FILE) BAREBOX_CMD_HELP(cmd_cp_help) BAREBOX_CMD_END - diff --git a/commands/devinfo.c b/commands/devinfo.c index 052a4a017b..e61aaa24e8 100644 --- a/commands/devinfo.c +++ b/commands/devinfo.c @@ -118,34 +118,6 @@ static int do_devinfo(int argc, char *argv[]) return 0; } - -/** - * @page devinfo_command - -If called without arguments, devinfo shows a summary of the known -devices and drivers. - -If called with a device path being the argument, devinfo shows more -default information about this device and its parameters. - -Example from an MPC5200 based system: - -@verbatim - barebox:/ devinfo /dev/eth0 - base : 0x1002b000 - size : 0x00000000 - driver: fec_mpc5xxx - - no info available for eth0 - Parameters: - ipaddr = 192.168.23.197 - ethaddr = 80:81:82:83:84:86 - gateway = 192.168.23.1 - netmask = 255.255.255.0 - serverip = 192.168.23.2 -@endverbatim - */ - BAREBOX_CMD_HELP_START(devinfo) BAREBOX_CMD_HELP_TEXT("If called without arguments, devinfo shows a summary of the known") BAREBOX_CMD_HELP_TEXT("devices.") diff --git a/commands/dfu.c b/commands/dfu.c index b71cc16d26..354625260d 100644 --- a/commands/dfu.c +++ b/commands/dfu.c @@ -186,16 +186,6 @@ BAREBOX_CMD_HELP_OPT ("-V ID", "vendor id") BAREBOX_CMD_HELP_OPT ("-P ID", "product id") BAREBOX_CMD_HELP_END -/** - * @page dfu_command -\ has the following form: -device1(name1)[sr],device2(name2)[sr] -'s' means 'safe mode' (download the complete image before flashing) and -'r' that readback of the firmware is allowed. - -\todo Add example, how to use dfu from a Linux or Windows host. - */ - BAREBOX_CMD_START(dfu) .cmd = do_dfu, BAREBOX_CMD_DESC("device firmware update") diff --git a/commands/echo.c b/commands/echo.c index 9b3e21e4b1..7d47ab7ca7 100644 --- a/commands/echo.c +++ b/commands/echo.c @@ -113,13 +113,6 @@ BAREBOX_CMD_HELP_OPT ("-a FILE", "append to FILE instead of using stdout") BAREBOX_CMD_HELP_OPT ("-o FILE", "overwrite FILE instead of using stdout") BAREBOX_CMD_HELP_END -/** - * @page echo_command - -\todo Add documentation for -a, -o and -e. - - */ - BAREBOX_CMD_START(echo) .cmd = do_echo, BAREBOX_CMD_DESC("echo args to console") @@ -127,4 +120,3 @@ BAREBOX_CMD_START(echo) BAREBOX_CMD_GROUP(CMD_GRP_CONSOLE) BAREBOX_CMD_HELP(cmd_echo_help) BAREBOX_CMD_END - diff --git a/commands/edit.c b/commands/edit.c index f6b9d406e0..5a2da7d034 100644 --- a/commands/edit.c +++ b/commands/edit.c @@ -15,11 +15,6 @@ * */ -/** - * @file - * @brief A tiny editor implementation - */ - #include #include #include @@ -550,16 +545,6 @@ BAREBOX_CMD_HELP_START(edit) BAREBOX_CMD_HELP_TEXT("Use cursor keys, Ctrl-C to exit and Ctrl-D to exit-with-save.") BAREBOX_CMD_HELP_END -/** - * @page edit_command - -

Barebox contains a small text editor which can be used to edit -config files in /env. You can move the cursor around with the arrow keys -and type characters.

- -If called as sedit, the editor uses ansi codes to scroll the screen. - */ - BAREBOX_CMD_START(edit) .cmd = do_edit, .aliases = edit_aliases, @@ -568,4 +553,3 @@ BAREBOX_CMD_START(edit) BAREBOX_CMD_GROUP(CMD_GRP_CONSOLE) BAREBOX_CMD_HELP(cmd_edit_help) BAREBOX_CMD_END - diff --git a/commands/flash.c b/commands/flash.c index b50a32702e..99d3cb7c3f 100644 --- a/commands/flash.c +++ b/commands/flash.c @@ -19,11 +19,6 @@ * */ -/** - * @file - * @brief Flash memory support: erase, protect, unprotect - */ - #include #include #include @@ -92,20 +87,6 @@ BAREBOX_CMD_START(erase) BAREBOX_CMD_HELP(cmd_erase_help) BAREBOX_CMD_END -/** - * @page erase_command - -

Erase the flash memory handled by this device. Which area will be -erased depends on the device: If the device represents the whole flash -memory, the whole memory will be erased. If the device represents a -partition on a main flash memory, only this partition part will be -erased.

- -Refer to \ref addpart_command, \ref delpart_command and \ref -devinfo_command for partition handling. - - */ - static int do_protect(int argc, char *argv[]) { int fd; @@ -173,23 +154,6 @@ BAREBOX_CMD_START(protect) BAREBOX_CMD_HELP(cmd_protect_help) BAREBOX_CMD_END -/** - * @page protect_command - - -If the device represents the whole -flash memory the whole memory will be protected. If the device -represents a partition on a main flash memory, only this partition part -will be protected. - -Refer addpart_command, delpart_command and devinfo_command for partition -handling. - -\todo Rework this documentation, what is an 'area'? Explain more about -flashes here. - - */ - BAREBOX_CMD_HELP_START(unprotect) BAREBOX_CMD_HELP_TEXT("Unprotect the flash memory behind the device. It depends on the device") BAREBOX_CMD_HELP_TEXT("given, what area will be unprotected. If the device represents the whole") @@ -205,19 +169,3 @@ BAREBOX_CMD_START(unprotect) BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP) BAREBOX_CMD_HELP(cmd_unprotect_help) BAREBOX_CMD_END - -/** - * @page unprotect_command - -It depends on the device given, -what area will be unprotected. If the device represents the whole flash memory -the whole memory will be unprotected. If the device represents a partition -on a main flash memory, only this partition part will be unprotected. - -Refer addpart_command, delpart_command and devinfo_command for partition -handling. - -\todo Rework this documentation, what does it mean? - - */ - diff --git a/commands/gpio.c b/commands/gpio.c index 4f2d93ee7d..08ecc152d9 100644 --- a/commands/gpio.c +++ b/commands/gpio.c @@ -107,65 +107,3 @@ BAREBOX_CMD_START(gpio_direction_output) BAREBOX_CMD_OPTS("GPIO VALUE") BAREBOX_CMD_GROUP(CMD_GRP_HWMANIP) BAREBOX_CMD_END - -/** - * @page gpio_for_users GPIO Handling - -@section regular_gpio General usage information - -These commands are available if the symbol @b CONFIG_GENERIC_GPIO and @b -CONFIG_CMD_GPIO are enabled in Kconfig. - -@note All gpio related commands take a number to identify the pad. This -number is architecture dependent and may not directly correlate with the -pad numbers. Due to this, it is also possible that the numbers changes -between @b barebox releases. - -@section gpio_dir_out Use Pad as GPIO Output -@verbatim -# gpio_direction_output -@endverbatim -- gpio_no: Architecture dependend GPIO number -- initial_value: Output value - -

To avoid glitches on the pad the routines will first set up the -pad's value and afterwards switch the pad to output (if the silicon is -able to do so). If the pad is already configured in non-GPIO mode (if -available), this command may silently fail.

- -@section gpio_dir_in Use Pad as GPIO Input -@verbatim -# gpio_direction_input -@endverbatim -- gpio_no: Architecture dependent GPIO number - -

If the pad is already configured in non-GPIO mode (if available), -this command may silently fail.

- -@section gpio_get_value Read Input Value from GPIO Pin -@verbatim -# gpio_get_value -@endverbatim - -

Reads the current value of a GPIO pin and return the value as a -shell return code. There is no visible output on stdout. You can check -the return value by using "echo $?".

- -

A return code other than '0' or '1' specifies an error code.

- -

If the pad is not configured in GPIO mode, this command may silently -fail and return garbage.

- -@section gpio_set_value Set Output Value on GPIO Pin -@verbatim -# gpio_set_value -@endverbatim -- gpio_no: Architecture dependent GPIO number -- value: Output value - -

Set a new output value on pad with GPIO number \.

- -

If the pad is not configured in GPIO-mode, this command may silently -fail.

- -*/ diff --git a/commands/led.c b/commands/led.c index 62c72a3315..354f74df8f 100644 --- a/commands/led.c +++ b/commands/led.c @@ -70,15 +70,6 @@ static int do_led(int argc, char *argv[]) return 0; } -/** - * @page led_command - -The exact meaning of is unspecified. It can be a color in case of rgb -LEDs or a brightness if this is controllable. In most cases only 1 for enabled -is allowed. - -*/ - BAREBOX_CMD_HELP_START(led) BAREBOX_CMD_HELP_TEXT("Control the value of a LED. The exact meaning of VALUE is unspecified,") BAREBOX_CMD_HELP_TEXT("it can be a brightness, or a color. Most often a value of '1' means on") diff --git a/commands/linux16.c b/commands/linux16.c index 65814f4ce7..594efc7dc2 100644 --- a/commands/linux16.c +++ b/commands/linux16.c @@ -330,18 +330,6 @@ BAREBOX_CMD_HELP_TEXT("Options:") BAREBOX_CMD_HELP_OPT ("-v VESAMODE", "set VESAMODE") BAREBOX_CMD_HELP_END -/** - * @page linux16_command - -

Only kernel images in bzImage format are supported by now. See \ref -x86_boot_preparation for more info about how to use this command.

- -

For the video mode refer the Linux kernel documentation -'Documentation/fb/vesafb.txt' for correct VESA mode numbers. If the keyword -'ask' instead of a number is given, the starting kernel will ask for a number. -

- */ - BAREBOX_CMD_START(linux16) .cmd = do_linux16, BAREBOX_CMD_DESC("boot a linux kernel on x86 via real-mode code") @@ -349,57 +337,3 @@ BAREBOX_CMD_START(linux16) BAREBOX_CMD_GROUP(CMD_GRP_BOOT) BAREBOX_CMD_HELP(cmd_linux16_help) BAREBOX_CMD_END - -/** - * @file - * @brief Boot support for Linux on x86 - */ - -/** - * @page x86_boot_preparation Linux Preparation on x86 - * - * Due to some real mode constraints, starting Linux is somehow tricky. - * Currently only @p bzImages are supported, because @p zImages would - * interfere with the @a barebox runtime. - * Also older load header versions than 2.00 aren't supported. - * - * The memory layout immediately before starting the Linux kernel: - * -@verbatim - real mode space hole extended memory - |---------------------------------------------->|----------->|------------------------------> - 0 0x7e00 0x90000 0xa0000 0x100000 - <-1-|----------2-----------><-3- | - <-4--|-5--> |---------6-------------> -@endverbatim - * - * @li 1 = @a barebox's real mode stack - * @li 2 = @a barebox's code - * @li 3 = @a barebox's flat mode stack - * @li 4 = real mode stack, when starting the Linux kernel - * @li 5 = Kernel's real mode setup code - * @li 6 = compressed kernel image - * - * A more detailed memory layout for kernel's real mode setup code - * -@verbatim - - 0x90000 0x97fff 0x99000 0x990ff - ---|------------------------------------------|----------------|--------------------| - |<-------- max setup code size ----------->|<--heap/stack-->|<-- command line -->| - -@endverbatim - * - * The regular entry point into the setup code is 0x90200 (2nd sector) - * - * To start the kernel, it's own setup code will be called. To do so, it - * must be called in real mode. So, @a barebox switches back to real mode - * a last time and does a jump to the setup code entry point. Now its up to - * the setup code to deflate the kernel, switching to its own protected mode - * setup and starting the kernel itself. - * - * @note This scenario only works, if a BIOS is still present. In this case - * there is no need for @a barebox to forward any system related information - * to the kernel. Everything is detected by kernel's setup code. - * - */ diff --git a/commands/loadenv.c b/commands/loadenv.c index ba92613396..8b15af49df 100644 --- a/commands/loadenv.c +++ b/commands/loadenv.c @@ -112,15 +112,6 @@ BAREBOX_CMD_HELP_OPT("-s", "scrub old environment") BAREBOX_CMD_HELP_OPT("-d", "load default environment") BAREBOX_CMD_HELP_END -/** - * @page loadenv_command - -ENVFS can only handle files, directories are skipped silently. - -\todo This needs proper documentation. What is ENVFS, why is it FS etc. Explain the concepts. - - */ - BAREBOX_CMD_START(loadenv) .cmd = do_loadenv, BAREBOX_CMD_DESC("load environment from ENVFS") diff --git a/commands/miitool.c b/commands/miitool.c index b08be9c683..40e34e93cc 100644 --- a/commands/miitool.c +++ b/commands/miitool.c @@ -293,12 +293,6 @@ BAREBOX_CMD_HELP_TEXT("Options:") BAREBOX_CMD_HELP_OPT("-v", "increase verbosity") BAREBOX_CMD_HELP_END -/** - * @page miitool_command -This utility checks or sets the status of a network interface's -Media Independent Interface (MII) unit. Most fast ethernet -adapters use an MII to autonegotiate link speed and duplex setting. - */ BAREBOX_CMD_START(miitool) .cmd = do_miitool, BAREBOX_CMD_DESC("view media-independent interface status") diff --git a/commands/mount.c b/commands/mount.c index 7aa155edbe..939e9bc853 100644 --- a/commands/mount.c +++ b/commands/mount.c @@ -17,11 +17,6 @@ * */ -/** - * @file - * @brief Filesystem mounting support - */ - #include #include #include @@ -130,37 +125,6 @@ BAREBOX_CMD_HELP_OPT("-o OPTIONS", "set file system OPTIONS") BAREBOX_CMD_HELP_OPT("-v\t", "verbose") BAREBOX_CMD_HELP_END -/** - * @page mount_command - -
    -
  • \ can be a device in /dev or some arbitrary string if no - device is needed for this driver, i.e. on ramfs.
    • -
  • \ is the filesystem driver. A list of available drivers can - be shown with the \ref devinfo_command command.
    • -
  • \ must be an empty directory, one level below the / - directory.
    • -
- - */ - -/** - * @page how_mount_works How mount works in barebox - -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. - - */ - BAREBOX_CMD_START(mount) .cmd = do_mount, BAREBOX_CMD_DESC("mount a filesystem or list mounted filesystems") diff --git a/commands/partition.c b/commands/partition.c index 51988dfa7f..ef6d9c9e2c 100644 --- a/commands/partition.c +++ b/commands/partition.c @@ -180,18 +180,6 @@ BAREBOX_CMD_HELP_TEXT("The size of the last partition can be specified as '-' fo BAREBOX_CMD_HELP_TEXT("space on the device.") BAREBOX_CMD_HELP_END -/** - * @page addpart_command - -The size and the offset can be given in decimal (without any prefix) and -in hex (prefixed with 0x). Both can have an optional suffix K, M or G. -The size of the last partition can be specified as '-' for the remaining -space on the device. This format is the same as used by the Linux -kernel or cmdline mtd partitions. - -\todo This command has to be reworked and will probably change it's API. -*/ - BAREBOX_CMD_START(addpart) .cmd = do_addpart, BAREBOX_CMD_DESC("add a partition description to a device") @@ -219,17 +207,6 @@ BAREBOX_CMD_HELP_START(delpart) BAREBOX_CMD_HELP_TEXT("Delete partitions previously added to a device with addpart.") BAREBOX_CMD_HELP_END -/** - * @page delpart_command - -Partitions are created by adding their description with the addpart -command. If you want to get rid of a partition again, use delpart. The -argument list is taken as a list of partitions to be deleted. - -\todo Add an example - - */ - BAREBOX_CMD_START(delpart) .cmd = do_delpart, BAREBOX_CMD_DESC("delete partition(s)") @@ -238,4 +215,3 @@ BAREBOX_CMD_START(delpart) BAREBOX_CMD_HELP(cmd_delpart_help) BAREBOX_CMD_COMPLETE(devfs_partition_complete) BAREBOX_CMD_END - diff --git a/commands/printenv.c b/commands/printenv.c index 83353aeb32..161c214462 100644 --- a/commands/printenv.c +++ b/commands/printenv.c @@ -15,11 +15,6 @@ * */ -/** - * @file - * @brief printenv: Print out environment variables - */ - #include #include #include @@ -62,15 +57,6 @@ BAREBOX_CMD_HELP_TEXT("variable to the terminal. If no argument is specified, al BAREBOX_CMD_HELP_TEXT("printed.") BAREBOX_CMD_HELP_END -/** - * @page printenv_command - -

If an argument is given, printenv prints the content of an environment -variable to the terminal. If no argument is specified, all variables are -printed.

- - */ - BAREBOX_CMD_START(printenv) .cmd = do_printenv, BAREBOX_CMD_DESC("print value of environment variables") diff --git a/commands/saveenv.c b/commands/saveenv.c index d629a94c5d..54b6fa1b7b 100644 --- a/commands/saveenv.c +++ b/commands/saveenv.c @@ -15,11 +15,6 @@ * */ -/** - * @file - * @brief saveenv: Make the environment persistent - */ - #include #include #include @@ -64,16 +59,3 @@ BAREBOX_CMD_START(saveenv) BAREBOX_CMD_GROUP(CMD_GRP_ENV) BAREBOX_CMD_HELP(cmd_saveenv_help) BAREBOX_CMD_END - -/** - * @page saveenv_command - -

\ is usually a block in flash but can be any other file. If -omitted, \ defaults to /env and \ defaults to -/dev/env0. Note that envfs can only handle files, directories are being -skipped silently.

- -\todo What does 'block in flash' mean? Add example. - - */ - diff --git a/commands/setenv.c b/commands/setenv.c index 9e21ccec8c..af4dd29ac4 100644 --- a/commands/setenv.c +++ b/commands/setenv.c @@ -15,11 +15,6 @@ * */ -/** - * @file - * @brief setenv: Set an environment variables - */ - #include #include #include @@ -40,14 +35,6 @@ BAREBOX_CMD_HELP_TEXT("Set environment variable NAME to VALUE.") BAREBOX_CMD_HELP_TEXT("If VALUE is ommitted, then the variable is deleted.") BAREBOX_CMD_HELP_END -/** - * @page setenv_command - -

This command is only available if the simple command line parser is -in use. Within the hush shell, \c setenv is not required.

- - */ - BAREBOX_CMD_START(setenv) .cmd = do_setenv, BAREBOX_CMD_DESC("set environment variable") diff --git a/commands/splash.c b/commands/splash.c index c61a1d76a1..5d0c0ad188 100644 --- a/commands/splash.c +++ b/commands/splash.c @@ -89,17 +89,6 @@ BAREBOX_CMD_HELP_OPT ("-b COLOR", "background color in 0xttrrggbb") BAREBOX_CMD_HELP_OPT ("-o\t", "render offscreen") BAREBOX_CMD_HELP_END -/** - * @page bmp_command - -This command displays a graphics in the bitmap (.bmp) format on the -framebuffer. Currently the bmp command supports images with 8 and 24 bit -color depth. - -\todo What does the -o (offscreen) option do? - - */ - BAREBOX_CMD_START(splash) .cmd = do_splash, BAREBOX_CMD_DESC("display a BMP image") diff --git a/commands/usbserial.c b/commands/usbserial.c index 1c26246f7c..e4c2f18024 100644 --- a/commands/usbserial.c +++ b/commands/usbserial.c @@ -92,10 +92,6 @@ BAREBOX_CMD_HELP_OPT ("-s", "Generic Serial") BAREBOX_CMD_HELP_OPT ("-d", "Disable the serial gadget") BAREBOX_CMD_HELP_END -/** - * @page usbserial_command - */ - BAREBOX_CMD_START(usbserial) .cmd = do_usbserial, BAREBOX_CMD_DESC("serial gadget enable/disable") -- cgit v1.2.3