-@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 62c72a331..354f74df8 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 65814f4ce..594efc7dc 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 ba9261339..8b15af49d 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 b08be9c68..40e34e93c 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 7aa155edb..939e9bc85 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 946cf2dfb..ef6d9c9e2 100644
--- a/commands/partition.c
+++ b/commands/partition.c
@@ -166,30 +166,20 @@ static int do_addpart(int argc, char *argv[])
BAREBOX_CMD_HELP_START(addpart)
+BAREBOX_CMD_HELP_TEXT("Options:")
+BAREBOX_CMD_HELP_OPT ("-n", "do not use the device name as prefix of the partition name")
+BAREBOX_CMD_HELP_TEXT("")
+BAREBOX_CMD_HELP_TEXT("Create partitions on device DEVICE using the partition description")
+BAREBOX_CMD_HELP_TEXT("from PART.")
+BAREBOX_CMD_HELP_TEXT("PART contains a partition description compatible to the Kernel mtd")
+BAREBOX_CMD_HELP_TEXT("commandline partition description:")
+BAREBOX_CMD_HELP_TEXT("SIZE1[@OFFSET1](NAME1)[RO],SIZE2[@OFFSET2](NAME2)[RO],...")
BAREBOX_CMD_HELP_TEXT("The size and the offset can be given in decimal (without any prefix) and")
BAREBOX_CMD_HELP_TEXT("in hex (prefixed with 0x). Both can have an optional suffix K, M or G.")
BAREBOX_CMD_HELP_TEXT("The size of the last partition can be specified as '-' for the remaining")
-BAREBOX_CMD_HELP_TEXT("space on the device. This format is the same as used by the Linux")
-BAREBOX_CMD_HELP_TEXT("kernel or cmdline mtd partitions.")
-BAREBOX_CMD_HELP_TEXT("")
-BAREBOX_CMD_HELP_TEXT("Options:")
-BAREBOX_CMD_HELP_OPT ("-n", "do not use the device name as prefix of the partition name")
-BAREBOX_CMD_HELP_OPT ("DEVICE", "device being worked on")
-BAREBOX_CMD_HELP_OPT ("PART", "SIZE1[@OFFSET1](NAME1)[RO],SIZE2[@OFFSET2](NAME2)[RO],...")
+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")
@@ -217,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)")
@@ -236,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 83353aeb3..161c21446 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 d629a94c5..54b6fa1b7 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 9e21ccec8..af4dd29ac 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 c61a1d76a..2ce1bdda8 100644
--- a/commands/splash.c
+++ b/commands/splash.c
@@ -78,8 +78,9 @@ static int do_splash(int argc, char *argv[])
}
BAREBOX_CMD_HELP_START(splash)
-BAREBOX_CMD_HELP_TEXT("This command displays a graphics in the bitmap (.bmp) format on the")
-BAREBOX_CMD_HELP_TEXT("framebuffer. Currently images with 8 and 24 bit color depth are supported.")
+BAREBOX_CMD_HELP_TEXT("This command displays a graphics image of either bitmap (.bmp) format")
+BAREBOX_CMD_HELP_TEXT("or Portable Network Graphics (.png) format on the framebuffer.")
+BAREBOX_CMD_HELP_TEXT("Currently images with 8 and 24 bit color depth are supported.")
BAREBOX_CMD_HELP_TEXT("")
BAREBOX_CMD_HELP_TEXT("Options:")
BAREBOX_CMD_HELP_OPT ("-f FB\t", "framebuffer device (default /dev/fb0)")
@@ -89,20 +90,9 @@ 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")
+ BAREBOX_CMD_DESC("display a BMP or PNG splash image")
BAREBOX_CMD_OPTS("[-fxyno] FILE")
BAREBOX_CMD_GROUP(CMD_GRP_CONSOLE)
BAREBOX_CMD_HELP(cmd_splash_help)
diff --git a/commands/ubiformat.c b/commands/ubiformat.c
index 5c8a36343..443d645a5 100644
--- a/commands/ubiformat.c
+++ b/commands/ubiformat.c
@@ -26,7 +26,7 @@
*/
#define MAX_CONSECUTIVE_BAD_BLOCKS 4
-#define PROGRAM_NAME "ubiformat"
+#define PROGRAM_NAME "ubiformat"
#include
#include
@@ -337,7 +337,7 @@ static int flash_image(const struct mtd_dev_info *mtd,
long long ec;
if (!args.quiet && !args.verbose) {
- printf("\r" PROGRAM_NAME ": flashing eraseblock %d -- %2u %% complete ",
+ printf("\rubiformat: flashing eraseblock %d -- %2u %% complete ",
eb, (eb + 1) * 100 / mtd->eb_cnt);
}
@@ -447,7 +447,7 @@ static int format(const struct mtd_dev_info *mtd,
long long ec;
if (!args.quiet && !args.verbose) {
- printf("\r" PROGRAM_NAME ": formatting eraseblock %d -- %2u %% complete ",
+ printf("\rubiformat: formatting eraseblock %d -- %2u %% complete ",
eb, (eb + 1 - start_eb) * 100 / (mtd->eb_cnt - start_eb));
}
@@ -781,8 +781,8 @@ BAREBOX_CMD_HELP_OPT("-Q NUM\t", "32-bit UBI image sequence number to use")
BAREBOX_CMD_HELP_OPT("-q\t", "suppress progress percentage information")
BAREBOX_CMD_HELP_OPT("-v\t", "be verbose")
BAREBOX_CMD_HELP_TEXT("")
-BAREBOX_CMD_HELP_TEXT("Example 1: " PROGRAM_NAME " /dev/nand0 -y - format nand0 and assume yes")
-BAREBOX_CMD_HELP_TEXT("Example 2: " PROGRAM_NAME " /dev/nand0 -q -e 0 - format nand0,")
+BAREBOX_CMD_HELP_TEXT("Example 1: ubiformat /dev/nand0 -y - format nand0 and assume yes")
+BAREBOX_CMD_HELP_TEXT("Example 2: ubiformat /dev/nand0 -q -e 0 - format nand0,")
BAREBOX_CMD_HELP_TEXT("\tbe quiet and force erase counter value 0.")
BAREBOX_CMD_HELP_END
diff --git a/commands/usbserial.c b/commands/usbserial.c
index 1c26246f7..e4c2f1802 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")
diff --git a/common/kallsyms.c b/common/kallsyms.c
index 121b77cc8..53e22cdc7 100644
--- a/common/kallsyms.c
+++ b/common/kallsyms.c
@@ -3,8 +3,6 @@
#include
#include
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
/* These will be re-linked against their real values during the second link stage */
extern const unsigned long kallsyms_addresses[] __attribute__((weak));
extern const unsigned long kallsyms_num_syms __attribute__((weak));
@@ -15,8 +13,6 @@ extern const u16 kallsyms_token_index[] __attribute__((weak));
extern const unsigned long kallsyms_markers[] __attribute__((weak));
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
static inline int is_kernel_text(unsigned long addr)
{
if ((addr >= (unsigned long)_stext && addr <= (unsigned long)_etext))
diff --git a/include/command.h b/include/command.h
index 347ad2f3e..5d5bf5354 100644
--- a/include/command.h
+++ b/include/command.h
@@ -90,8 +90,6 @@ void barebox_cmd_usage(struct command *cmdtp);
#endif /* __ASSEMBLY__ */
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#define Struct_Section __attribute__ ((unused,section (".barebox_cmd")))
#define BAREBOX_CMD_START(_name) \
@@ -127,8 +125,6 @@ static const __maybe_unused char cmd_##_name##_help[] =
#define BAREBOX_CMD_OPTS(text) .opts = text,
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
int register_command(struct command *);
#endif /* __COMMAND_H */
diff --git a/include/driver.h b/include/driver.h
index ffc0cbaf7..53e100006 100644
--- a/include/driver.h
+++ b/include/driver.h
@@ -28,32 +28,6 @@
#include
-/**
- * @file
- * @brief Main description of the device/driver model
- */
-
-/** @page driver_model Main description of the device/driver model
- *
- * We follow a rather simplistic driver model here. There is a
- * @code struct device_d @endcode
- * which describes a particular device present in the system.
- *
- * On the other side a
- * @code struct driver_d @endcode
- * represents a driver present in the system.
- *
- * Both structs find together via the members 'type' (int) and 'name' (char *).
- * If both members match, the driver's probe function is called with the
- * struct device_d as argument.
- *
- * People familiar with the Linux platform bus will recognize this behaviour
- * and in fact many things were stolen from there. Some selected members of the
- * structs will be described in this document.
- */
-
-/*@{*/ /* do not delete, doxygen relevant */
-
struct filep;
struct bus_type;
diff --git a/include/i2c/i2c.h b/include/i2c/i2c.h
index f89fefbb2..a107f5edb 100644
--- a/include/i2c/i2c.h
+++ b/include/i2c/i2c.h
@@ -19,8 +19,6 @@
#include
#include
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
/*
* struct i2c_platform_data - structure of platform data for MXC I2C driver
* @param bitrate Bus speed measured in Hz
@@ -153,8 +151,6 @@ extern int i2c_master_recv(struct i2c_client *client, char *buf, int count);
extern int i2c_read_reg(struct i2c_client *client, u32 addr, u8 *buf, u16 count);
extern int i2c_write_reg(struct i2c_client *client, u32 addr, const u8 *buf, u16 count);
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
extern struct bus_type i2c_bus;
static inline int i2c_driver_register(struct driver_d *drv)
diff --git a/include/linux/mtd/mtd-abi.h b/include/linux/mtd/mtd-abi.h
index c1ba55bd2..c46605d5e 100644
--- a/include/linux/mtd/mtd-abi.h
+++ b/include/linux/mtd/mtd-abi.h
@@ -7,8 +7,6 @@
#ifndef __MTD_ABI_H__
#define __MTD_ABI_H__
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include
struct erase_info_user {
@@ -183,6 +181,4 @@ static inline uint32_t mtd_user_div_by_eb(uint64_t sz,
return sz;
}
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
#endif /* __MTD_ABI_H__ */
diff --git a/include/linux/mtd/mtd.h b/include/linux/mtd/mtd.h
index 5f02aee2d..1d33592fe 100644
--- a/include/linux/mtd/mtd.h
+++ b/include/linux/mtd/mtd.h
@@ -9,8 +9,6 @@
#ifndef __MTD_MTD_H__
#define __MTD_MTD_H__
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include
#include
#include
@@ -325,8 +323,6 @@ int mtd_all_ff(const void *buf, unsigned int len);
#endif /* CONFIG_MTD_DEBUG */
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
static inline int mtd_is_bitflip(int err) {
return err == -EUCLEAN;
}
diff --git a/include/spi/spi.h b/include/spi/spi.h
index b4358a84d..620e5e57b 100644
--- a/include/spi/spi.h
+++ b/include/spi/spi.h
@@ -1,8 +1,6 @@
#ifndef __INCLUDE_SPI_H
#define __INCLUDE_SPI_H
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include
#include
@@ -431,8 +429,6 @@ static inline ssize_t spi_w8r8(struct spi_device *spi, u8 cmd)
return (status < 0) ? status : result;
}
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
extern struct bus_type spi_bus;
struct spi_master *spi_get_master(int bus);
diff --git a/include/usb/ch9.h b/include/usb/ch9.h
index adbe53341..93223638f 100644
--- a/include/usb/ch9.h
+++ b/include/usb/ch9.h
@@ -33,8 +33,6 @@
#ifndef __LINUX_USB_CH9_H
#define __LINUX_USB_CH9_H
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include /* __u8 etc */
/*-------------------------------------------------------------------------*/
@@ -798,6 +796,4 @@ enum usb_device_state {
*/
};
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
#endif /* __LINUX_USB_CH9_H */
diff --git a/include/usb/composite.h b/include/usb/composite.h
index 798fa110e..379927a07 100644
--- a/include/usb/composite.h
+++ b/include/usb/composite.h
@@ -17,8 +17,6 @@
#ifndef __LINUX_USB_COMPOSITE_H
#define __LINUX_USB_COMPOSITE_H
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
/*
* This framework is an optional layer on top of the USB Gadget interface,
* making it easier to build (a) Composite devices, supporting multiple
@@ -343,6 +341,4 @@ extern int usb_string_id(struct usb_composite_dev *c);
#define WARNING(d, fmt, args...)
#define INFO(d, fmt, args...)
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
#endif /* __LINUX_USB_COMPOSITE_H */
diff --git a/include/usb/gadget.h b/include/usb/gadget.h
index ff1509ca7..798b51b3c 100644
--- a/include/usb/gadget.h
+++ b/include/usb/gadget.h
@@ -15,8 +15,6 @@
#ifndef __LINUX_USB_GADGET_H
#define __LINUX_USB_GADGET_H
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include
#include
#include
@@ -899,6 +897,4 @@ extern struct usb_ep *usb_ep_autoconfig(struct usb_gadget *,
extern void usb_ep_autoconfig_reset(struct usb_gadget *);
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
#endif /* __LINUX_USB_GADGET_H */
diff --git a/include/usb/usb.h b/include/usb/usb.h
index 1a369d2ee..4877e321b 100644
--- a/include/usb/usb.h
+++ b/include/usb/usb.h
@@ -22,8 +22,6 @@
#ifndef _USB_H_
#define _USB_H_
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
-
#include
#include
#include
@@ -516,8 +514,6 @@ struct usb_device_id {
#define USB_CTRL_SET_TIMEOUT 5000
#define USB_CTRL_GET_TIMEOUT 5000
-#endif /* DOXYGEN_SHOULD_SKIP_THIS */
-
enum usb_dr_mode of_usb_get_dr_mode(struct device_node *np,
const char *propname);
diff --git a/net/netconsole.c b/net/netconsole.c
index 86a68e19d..021820b13 100644
--- a/net/netconsole.c
+++ b/net/netconsole.c
@@ -32,11 +32,6 @@
#include
#include
-/**
- * @file
- * @brief Network console support
- */
-
struct nc_priv {
struct console_device cdev;
struct kfifo *fifo;
@@ -169,26 +164,3 @@ static int netconsole_init(void)
}
device_initcall(netconsole_init);
-
-/** @page net_netconsole Network console
-
-@section net_netconsole Using an UDP based network console
-
-If enabled barebox supports a console via udp networking. There is only
-one network console supported registered during init time. It is deactivated
-by default because it opens great security holes, so use with care.
-
-To use the network console you have to configure the remote ip and the local
-and remote ports. Assuming the network console is registered as cs1, it can be
-configured with:
-
-@code
-cs1.ip=
-cs1.port=
-cs1.active=ioe
-@endcode
-
-On the remote host call scripts/netconsole with bareboxes ip and port as
-parameters. port is initialized to 6666 by default.
-
-*/
diff --git a/scripts/doxy_filter.awk b/scripts/doxy_filter.awk
deleted file mode 100644
index 5ec040629..000000000
--- a/scripts/doxy_filter.awk
+++ /dev/null
@@ -1,103 +0,0 @@
-#!/usr/bin/awk
-
-/BAREBOX_CMD_HELP_START[[:space:]]*\((.*)\)/ {
-
- this_opt = 0;
- my_usage = "";
- my_short = "";
- my_cmd = gensub("BAREBOX_CMD_HELP_START[[:space:]]*\\((.*)\\)", "\\1", "g");
- this_text = 0;
- delete(my_text);
- delete(my_opts);
- next;
-}
-
-/BAREBOX_CMD_HELP_USAGE[[:space:]]*\((.*)\)/ {
-
- $0 = gensub("<", "\\<", "g");
- $0 = gensub(">", "\\>", "g");
- $0 = gensub("BAREBOX_CMD_HELP_USAGE[[:space:]]*\\((.*)\\)", "\\1", "g");
- $0 = gensub("\\\\n", "", "g");
- my_usage = gensub("\"", "", "g");
- next;
-
-}
-
-/BAREBOX_CMD_HELP_SHORT[[:space:]]*\((.*)\)/ {
-
- $0 = gensub("<", "\\<", "g");
- $0 = gensub(">", "\\>", "g");
- $0 = gensub("BAREBOX_CMD_HELP_SHORT[[:space:]]*\\((.*)\\)", "\\1", "g");
- $0 = gensub("\\\\n", "", "g");
- my_short = gensub("\"", "", "g");
- next;
-
-}
-
-/BAREBOX_CMD_HELP_OPT[[:space:]]*\([[:space:]]*(.*)[[:space:]]*,[[:space:]]*(.*)[[:space:]]*\)/ {
-
- $0 = gensub("<", "\\<", "g");
- $0 = gensub(">", "\\>", "g");
- $0 = gensub("@", "\\\\@", "g");
- $0 = gensub("BAREBOX_CMD_HELP_OPT[[:space:]]*\\([[:space:]]*\"*(.*)\"[[:space:]]*,[[:space:]]*\"(.*)\"[[:space:]]*\\)", \
- " \\1 | \\ \\ \\ | \\2 |
", "g");
- $0 = gensub("\\\\n", "", "g");
- my_opts[this_opt] = gensub("\"", "", "g");
- this_opt ++;
- next;
-}
-
-/BAREBOX_CMD_HELP_TEXT[[:space:]]*\((.*)\)/ {
-
- $0 = gensub("<", "\\<", "g");
- $0 = gensub(">", "\\>", "g");
- $0 = gensub("BAREBOX_CMD_HELP_TEXT[[:space:]]*\\((.*)\\)", "\\1", "g");
- $0 = gensub("\\\\n", "
", "g");
- my_text[this_text] = gensub("\"", "", "g");
- this_text ++;
- next;
-}
-
-/BAREBOX_CMD_HELP_END/ {
-
- printf "/**\n";
- printf " * @page " my_cmd "_command " my_cmd "\n";
- printf " *\n";
- printf " * \\par Usage:\n";
- printf " * " my_usage "\n";
- printf " *\n";
-
- if (this_opt != 0) {
- printf " * \\par Options:\n";
- printf " *\n";
- printf " * \n";
- n = asorti(my_opts, my_opts_sorted);
- for (i=1; i<=n; i++) {
- printf " * " my_opts[my_opts_sorted[i]] "\n";
- }
- printf " *
\n";
- printf " *\n";
- }
-
- printf " * " my_short "\n";
- printf " *\n";
-
- n = asorti(my_text, my_text_sorted);
- if (n > 0) {
- for (i=1; i<=n; i++) {
- printf " * " my_text[my_text_sorted[i]] "\n";
- }
- printf " *\n";
- }
-
- printf " */\n";
-
- next;
-}
-
-/^.*$/ {
-
- print $0;
-
-}
-
diff --git a/scripts/setupmbr/setupmbr.c b/scripts/setupmbr/setupmbr.c
index 0060c2e93..f1dfd5fde 100644
--- a/scripts/setupmbr/setupmbr.c
+++ b/scripts/setupmbr/setupmbr.c
@@ -556,146 +556,3 @@ on_error:
return rc;
}
-
-/** @page x86_bootloader barebox acting as PC bootloader
-
-@section x86_bootloader_features Features
-
-@a barebox can act as a bootloader for PC based systems. In this case a special
-binary layout will be created to be able to store it on some media the PC
-BIOS can boot from. It can boot Linux kernels stored also on the same boot
-media and be configured at runtime, with the possibility to store the changed
-configuration on the boot media.
-
-@section x86_bootloader_restrictions Restrictions
-
-Due to some BIOS and @a barebox restrictions the boot media must be
-prepared in some special way:
-
-@li @a barebox must be stored in the MBR (Master Boot Record) of the boot media.
- Currently its not possible to store and boot it in one of the partition
- sectors (to use it as a second stage loader). This is no eternal
- restriction. It only needs further effort to add this feature.
-@li @a barebox currently cannot run a chained boot loader. Also, this is no
- eternal restriction, only further effort needed.
-@li @a barebox comes with limited filesystem support. There is currently no
- support for the most common and popular filesystems used in the *NIX world.
- This restricts locations where to store a kernel and other runtime
- information
-@li @a barebox must be stored to the first n sectors of the boot media. To ensure
- this does not collide with partitions on the boot media, the first
- partition must start at a sector behind the ones @a barebox occupies.
-@li @a barebox handles its runtime configuration in a special way: It stores it
- in a binary way into some reserved sectors ("persistant storage").
-
-@section x86_bootloader_preparations Boot Preparations
-
-To store the @a barebox image to a boot media, it comes with the tool
-@p setupmbr in the directory @p scripts/setupmbr/ . To be able to use it on
-the boot media of your choice, some preparations are required:
-
-@subsection x86_bootloader_preparations_partition Keep Sectors free
-
-Build the @a barebox image and check its size. At least this amount of
-sectors must be kept free after the MBR prior the first partition. Do this
-simple calulation:
-
- sectors = (\ + 511) / 512
-
-To be able to store the runtime configuration, further free sectors are
-required. Its up to you and your requirements, how large this persistant
-storage must be. If you need 16 kiB for this purpose, you need to keep
-additional 32 sectors free.
-
-For this example we are reserving 300 sectors for the @a barebox image and
-additionaly 32 sectors for the persistant storage. So, the first partition on
-the boot media must start at sector 333 or later.
-
-Run the @p fdisk tool to setup such a partition table:
-
-@verbatim
-[jb@host]~> fdisk /dev/sda
-Command (m for help): p
-
-Disk /dev/sda: 20.7 MB, 212680704 bytes
-16 heads, 63 sectors/track, 406 cylinders
-Units = cylinders of 1008 * 512 = 516096 bytes
-
- Device Boot Start End Blocks Id System
-@endverbatim
-
-Change the used units to @p sectors for easier handling.
-
-@verbatim
-Command (m for help): u
-Changing display/entry units to sectors
-
-Command (m for help): p
-
-Disk /dev/sda: 20.7 MB, 212680704 bytes
-16 heads, 63 sectors/track, 406 cylinders, total 409248 sectors
-Units = sectors of 1 * 512 = 512 bytes
-
- Device Boot Start End Blocks Id System
-@endverbatim
-
-Now its possible to create the first partition with the required offset:
-
-@verbatim
-Command (m for help): n
-Command action
- e extended
- p primary partition (1-4)
-p
-Partition number (1-4): 1
-First sector (63-409247, default 63): 333
-Last sector or +size or +sizeM or +sizeK (333-409247, default 409247): +18M
-Command (m for help): p
-
-Disk /dev/sda: 20.7 MB, 212680704 bytes
-16 heads, 63 sectors/track, 406 cylinders, total 409248 sectors
-Units = sectors of 1 * 512 = 512 bytes
-
- Device Boot Start End Blocks Id System
-/dev/sda 333 35489 17578+ 83 Linux
-@endverbatim
-
-That's all. Do whatever is required now with the new partition (formatting
-and populating the root filesystem for example) to make it useful.
-
-In the next step, @a barebox gets installed to this boot media:
-
-@verbatim
-[jb@host]~> scripts/setupmbr/setupmbr -s 32 -m ./barebox.bin -d /dev/sda
-@endverbatim
-
-This command writes the @a barebox image file './barebox.bin' onto the device
-@p /dev/sda.
-
-The @p -s option will keep the persistant storage sectors free and untouched
-and set flags in the MBR to forward its existance, size and location to
-@a barebox at runtime. @p setupmbr also does not change the partition table.
-
-The @a barebox image gets stored on the boot media like this:
-
-@verbatim
-sector 0 1 33 333
- |---|-------------|--------------- ~~~ ------------|--------------
- MBR persistant barebox first
- storage main image partition
-@endverbatim
-
-If the @p -s option is omitted, the "persistant storage" part simply does
-not exist:
-
-@verbatim
-sector 0 1 333
- |---|--------------- ~~~ ------------|--------------
- MBR barebox first
- main image partition
-@endverbatim
-
-@note The @p setupmbr tool is also working on real image file than on device
- nodes only. So, there is no restriction what kind of file will be
- modified.
-*/