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 <s.hauer@pengutronix.de>

9 files changed, 0 insertions, 595 deletions

diff --git a/Documentation/barebox-main.dox b/Documentation/barebox-main.dox
deleted file mode 100644
index c98c75fe6b..0000000000
--- a/Documentation/barebox-main.dox
+++ /dev/null
@@ -1,126 +0,0 @@
-/** @mainpage Barebox
-
-Barebox is a bootloader that initializes hardware and boots Linux and
-maybe other operating systems or bare metal code on a variety of
-processors. It was initially derived from U-Boot and retains several of
-U-Boot's ideas, so users familiar with U-Boot should come into
-production quickly with Barebox.
-
-However, as the Barebox developers are highly addicted to the Linux
-kernel, its coding style and code quality, we try to stick as closely
-as possible to the methodologies and techniques developed in Linux. In
-addition we have a strong background in POSIX, so you'll find several
-good old Unix traditions realized in Barebox as well.
-
-@par Highlights:
-
-- <b>POSIX File API:</b><br>
-  @a Barebox uses the the well known open/close/read/write/lseek access
-  functions, together with a model of representing devices by files. This
-  makes the APIs familiar to everyone who has experience with Unix
-  systems.
-
-- <b>Shell:</b><br>
-  We have the standard shell commands like ls/cd/mkdir/echo/cat,...
-
-- <b>Environment Filesystem:</b><br>
-  In contrast to U-Boot, Barebox doesn't misuse the environment for
-  scripting. If you start the bootloader, it gives you a shell and
-  something that looks like a filesystem. In fact it isn't; it is a very
-  simple ar archive being extracted from flash into a ramdisk with 'loadenv'
-  and stored back with 'saveenv'.
-
-- <b>Filesystem Support:</b><br>
-  When starting up, the environment is mounted to /, followed by a
-  device filesytem being mounted to /dev in order to make it possible to
-  access devices. Other filesystems can be mounted on demand.
-
-- <b>Driver Model (borrowed from Linux):</b><br>
-  Barebox follows the Linux driver model: devices can be specified in a
-  hardware specific file, and drivers feel responsible for these devices
-  if they have the same name.
-
-- <b>Clocksource:</b><br>
-  We use the standard clocksource API from Linux.
-
-- <b>Kconfig/Kbuild:</b><br>
-  This gives us parallel builds and removes the need for lots of ifdefs.
-
-- <b>Sandbox:</b><br>
-  If you develop features for @a Barebox, you can use the 'sandbox'
-  target which compiles @a Barebox as a POSIX application in the Linux
-  userspace: it can be started like a normal command and even has
-  network access (tun/tap). Files from the local filesytem can be used
-  to simulate devices.
-
-- <b>Device Parameters:</b><br>
-  There is a parameter model in @a Barebox: each device can specify its
-  own parameters, which do exist for every instance. Parameters can be
-  changed on the command line with \<devid\>.\<param\>="...". For
-  example, if you want to access the IPv4 address for eth0, this is done
-  with 'eth0.ip=192.168.0.7' and 'echo $eth0.ip'.
-
-- <b>Getopt:</b><br>
-  @a Barebox has a lightweight getopt() implementation. This makes it
-  unnecessary to use positional parameters, which can be hard to read.
-
-- <b>Integrated Editor:</b><br>
-  Scripts can be edited with a small integrated fullscreen editor.
-  This editor has no features except the ones really needed: moving
-  the cursor around, typing characters, exiting and saving.
-
-
-@par Directory layout
-
-Most of the directory layout is based upon the Linux Kernel:
-
-@verbatim
-arch / * /                -> contains architecture specific parts
-arch / * / mach-* /       -> SoC specific code
-
-drivers / serial          -> drivers
-drivers / net
-drivers / ...
-
-include / asm-*           -> architecture specific includes
-include / asm-* / arch-*  -> SoC specific includes
-
-fs /                      -> filesystem support and filesystem drivers
-
-lib /                     -> generic library functions (getopt, readline and the
-                              like)
-
-common /                  -> common stuff
-
-commands /                -> many things previously in common/cmd_*, one command
-                             per file
-
-net /                     -> Networking stuff
-
-scripts /                 -> Kconfig system
-
-Documentation /           -> Parts of the documentation, also doxygen
-@endverbatim
-
-@section license barebox's License
-
-@verbatim
-This program is free software; you can redistribute it and/or
-modify it under the terms of the GNU General Public License as
-published by the Free Software Foundation; either version 2 of
-the License, or (at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-@endverbatim
-
-@subpage users_manual
-
-@subpage developers_manual
-
-@subpage supported_boards
-
-*/
diff --git a/Documentation/board.dox b/Documentation/board.dox
deleted file mode 100644
index e545709358..0000000000
--- a/Documentation/board.dox
+++ /dev/null
@@ -1,94 +0,0 @@
-/** @page dev_board Adapting a new Board
-
-To add a new board to @a barebox a few steps must be done, to extend and modify
-the @a barebox source tree.
-
-@section board_add_files Files/Directories to be added
-
- - arch/\<architecture\>/boards/\<boardname\>
- - arch/\<architecture\>/boards/\<boardname\>/Makefile
- - arch/\<architecture\>/boards/\<boardname\>/\<boardname\>.c
- - arch/\<architecture\>/boards/\<boardname\>/\<boardname\>.dox
- - include/configs/\<boardname\>.h
- - arch/\<architecture\>/configs/\<boardname\>_defconfig
-
-@subsection board_makefile arch/\<architecture\>/boards/\<boardname\>Makefile
-
-@verbatim
-	obj-y += all files that builds the BSP (Assembler and/or C files)
-@endverbatim
-
-@subsection board_basefile arch/\<architecture\>/boards/\<boardname\>\<boardname\>.c
-
-TBD
-
-@subsection board_doxygen arch/\<architecture\>/boards/\<boardname\>/\<boardname\>.dox
-
-This file should describe in short words your new board, what CPU
-it uses, what resources are provided and features it supports.
-
-Use the doxygen style for this kind of documentation. Below you find a
-template for this kind of file:
-
-@verbatim
-/** @page <boardname> <Manufacturer> <Board's Name>
-
-This board uses an <architecture> based CPU. The board is shipped with:
-
-- many MiB NOR type Flash Memory
-- many MiB SDRAM
-- a very special network controller
-
-and so on.
-
-*/
-@endverbatim
-
-To make your new shiny file visible in the automatically generated
-documentation you must sort in the used page lable ("<boardname>" in the
-template above) into Documentation/boards.dox as:
-
-@verbatim
- ...
- @subpage <boardname>
- ...
-@endverbatim
-
-at the right architecture.
-
-@note Consider to use an unique page lable.
-
-@subsection board_lscript arch/\<architecture\>/boards/\<boardname\>/barebox.lds.S
-
-If your board needs a special binary @a barebox layout, you can provide a local
-board linker script file. This will replace the generic one provided by your
-architecture or CPU support.
-
-Add this file with
-
-@verbatim
-	extra-y += <board_linker_script>
-@endverbatim
-
-in your local \b Makefile to the list of files, forwarded to the last linking step.
-
-@section board_defconfig arch/\<architecture\>/configs/\<boardname\>_defconfig
-
-TBD
-
-@section board_mod_files These files needs to be modified:
-
- - modify Documentation/board.dox
- - modify arch/\<architecture\>/Kconfig
-  - add your board (MACH_*) to the list
-  - add your default text base address for this architecture (ARCH_TEXT_BASE)
- - modify arch/\<architecture\>/Makefile:
-  - add board-$(MACH_*) = \<your board_dir\>
-
-First, the new board should be visible in the menu.
-
-@section board_specific_cpu Porting hints for specific CPUs
-
-@li @subpage dev_s3c24xx_mach
-
-*/
diff --git a/Documentation/boards.dox b/Documentation/boards.dox
deleted file mode 100644
index 8d4fabbdd3..0000000000
--- a/Documentation/boards.dox
+++ /dev/null
@@ -1,74 +0,0 @@
-/** @page supported_boards Supported Boards
-
-This is a list of boards that are currently supported by @a barebox.
-
-PowerPC type:
-
-@li @subpage pcm030
-
-ARM type:
-
-
-@li @subpage pcm037
-@li @subpage pcm038
-@li @subpage pcm043
-@li @subpage imx21ads
-@li @subpage imx27ads
-@li @subpage tx28
-@li @subpage the3stack
-@li @subpage mx23_evk
-@li @subpage board_babage
-@li @subpage board_loco
-@li @subpage chumbyone
-@li @subpage scb9328
-@li @subpage netx
-@li @subpage dev_omap_arch
-@li @subpage a9m2440
-@li @subpage a9m2410
-@li @subpage eukrea_cpuimx27
-@li @subpage eukrea_cpuimx35
-@li @subpage edb9301
-@li @subpage edb9302
-@li @subpage edb9302a
-@li @subpage edb9307
-@li @subpage edb9307a
-@li @subpage edb9312
-@li @subpage edb9315
-@li @subpage edb9315a
-@li @subpage board_cupid
-@li @subpage phycard-a-l1
-@li @subpage toshiba-ac100
-@li @subpage qil-a9260
-@li @subpage tny-a9g20-lpw
-@li @subpage tny-a9263
-@li @subpage usb-a9g20-lpw
-@li @subpage usb-a9263
-@li @subpage virt2real
-
-Blackfin type:
-
-@li @subpage ipe337
-
-x86 type:
-
-@li @subpage generic_pc
-
-
-MIPS type:
-
-@li @subpage dlink_dir_320
-@li @subpage loongson_ls1b
-@li @subpage qemu_malta
-@li @subpage ritmix-rzx50
-@li @subpage tplink-mr3020
-
-*/
-
-/* TODO
- *
- * Add documentation to your boardfile, forward it with doxygen's page
- * feature (@page <reference>) and include it here with:
- *
- * @subpage <reference>
- *
- */
diff --git a/Documentation/building.dox b/Documentation/building.dox
deleted file mode 100644
index 527ca45d05..0000000000
--- a/Documentation/building.dox
+++ /dev/null
@@ -1,60 +0,0 @@
-/** @page building Building
-
-<i>This section describes how to build the Barebox bootloader.</i>
-
-@a Barebox uses Kconfig/Kbuild from the Linux kernel to build it's
-sources. It consists of two parts: the makefile infrastructure (kbuild)
-and a configuration system (kconfig). So building @a barebox is very
-similar to building the Linux kernel.
-
-In the examples below we use the "sandbox" configuration, which is a
-port of @a Barebox to the Linux userspace. This makes it possible to
-test the code without having real hardware or even qemu. Note that the
-sandbox architecture does only work well on x86 and has some issues on
-x86_64.
-
-\todo Find out about issues on x86_64.
-
-Selecting the architecture and the corresponding cross compiler is done
-by setting the following environment variables:
-
-- ARCH=\<architecture>
-- CROSS_COMPILE=\<compiler-prefix>
-
-For @p ARCH=sandbox we do not need a cross compiler, so it is sufficient
-to specify the architecture:
-
-@code
-# export ARCH=sandbox
-@endcode
-
-In order to configure the various aspects of @a barebox, start the
-@a barebox configuration system:
-
-@code
-# make menuconfig
-@endcode
-
-This command starts a menu box and lets you select all the different
-options available for the selected architecture. Once the configuration
-is finished (you can simulate this by using the default config file with
-'make sandbox_defconfig'), there is a .config file in the toplevel
-directory of the sourcecode.
-
-After @a barebox is configured, we can start the compilation:
-
-@code
-# make
-@endcode
-
-You can use '-j \<n\>' in order to do a parallel build if you have more
-than one cpus.
-
-If everything goes well, the result is a file called @p barebox:
-
-@code
-# ls -l barebox
--rwxr-xr-x 1 rsc ptx 114073 Jun 26 22:34 barebox
-@endcode
-
-*/
diff --git a/Documentation/commands.dox b/Documentation/commands.dox
deleted file mode 100644
index d8cfa6b8f0..0000000000
--- a/Documentation/commands.dox
+++ /dev/null
@@ -1,111 +0,0 @@
-/**
- * @page command_reference Shell Commands
-
-<i>This section describes the commands which are available on the @a
-Barebox shell. </i>
-
-@a Barebox, as a bootloader, usually shall start the Linux kernel right
-away. However, there are several use cases around which make it
-necessary to have some (customizable) logic and interactive scripting
-possibilities. In order to achieve this, @a Barebox offers several
-commands on it's integrated commandline shell.
-
-The following alphabetically sorted list documents all commands
-available in @a Barebox:
-
-\todo Sort this by functionality?
-
-@li @subpage _name
-@li @subpage addpart_command
-@li @subpage alternate
-@li @subpage bootm_command
-@li @subpage bootu
-@li @subpage bootz
-@li @subpage cat_command
-@li @subpage cd_command
-@li @subpage clear_command
-@li @subpage clko
-@li @subpage cp_command
-@li @subpage cpufreq
-@li @subpage cpuinfo
-@li @subpage crc_command
-@li @subpage crc32
-@li @subpage delpart_command
-@li @subpage devinfo_command
-@li @subpage dfu_command
-@li @subpage dhcp
-@li @subpage dump_clocks
-@li @subpage echo_command
-@li @subpage edit_command
-@li @subpage erase_command
-@li @subpage ethact
-@li @subpage exec
-@li @subpage exit
-@li @subpage export_command
-@li @subpage false
-@li @subpage getopt
-@li @subpage gpio_get_value_command
-@li @subpage gpio_set_value_command
-@li @subpage gpio_direction_input_command
-@li @subpage gpio_direction_output_command
-@li @subpage go
-@li @subpage help
-@li @subpage host
-@li @subpage i2c_probe
-@li @subpage i2c_read
-@li @subpage i2c_write
-@li @subpage icache
-@li @subpage iminfo
-@li @subpage insmod
-@li @subpage linux16_command
-@li @subpage loadenv_command
-@li @subpage loadb
-@li @subpage loady
-@li @subpage loadxc
-@li @subpage login
-@li @subpage ls_command
-@li @subpage lsmod
-@li @subpage md
-@li @subpage memcmp
-@li @subpage meminfo
-@li @subpage memset
-@li @subpage menu
-@li @subpage mkdir
-@li @subpage mount_command
-@li @subpage mtest
-@li @subpage mw
-@li @subpage mycdev
-@li @subpage nand
-@li @subpage nand_boot_test
-@li @subpage nfs
-@li @subpage passwd
-@li @subpage ping
-@li @subpage printenv_command
-@li @subpage protect_command
-@li @subpage pwd
-@li @subpage readline
-@li @subpage reset
-@li @subpage rarpboot
-@li @subpage reginfo
-@li @subpage rm
-@li @subpage rmdir
-@li @subpage saveenv_command
-@li @subpage setenv_command
-@li @subpage sh
-@li @subpage sleep
-@li @subpage source
-@li @subpage splash_command
-@li @subpage test
-@li @subpage timeout
-@li @subpage true
-@li @subpage tftp_command
-@li @subpage ubiattach
-@li @subpage ubimkvol
-@li @subpage ubirmvol
-@li @subpage umount
-@li @subpage unlzo
-@li @subpage unprotect_command
-@li @subpage usb
-@li @subpage version
-
-*/
diff --git a/Documentation/developers_manual.dox b/Documentation/developers_manual.dox
deleted file mode 100644
index 2f7d3605ef..0000000000
--- a/Documentation/developers_manual.dox
+++ /dev/null
@@ -1,24 +0,0 @@
-/** @page developers_manual Developer's Manual
-
-This part of the documentation is intended for developers of @a barebox.
-
-@section devel_backgrounds Some background knowledge for some frameworks barebox
-
-@li @subpage driver_model
-@li @subpage dev_params
-
-@section devel_hints Hints and tips for simply adapting barebox
-
-@li @subpage dev_architecture
-@li @subpage dev_cpu
-@li @subpage dev_board
-
-@section devel_themes Various themes about barebox
-
-@li @subpage how_mount_works
-@li @subpage boot_preparation
-@li @subpage barebox_simul
-@li @subpage io_access_functions
-@li @subpage mcfv4e_MCDlib
-
-*/
diff --git a/Documentation/first_steps.dox b/Documentation/first_steps.dox
deleted file mode 100644
index 17fdf3748c..0000000000
--- a/Documentation/first_steps.dox
+++ /dev/null
@@ -1,61 +0,0 @@
-/** @page first_steps First Steps
-
-<i>This section demonstrates the first steps with the 'sandbox'
-platform. </i>
-
-@a barebox usually needs an environment for storing its configuration.
-You can generate an environment using the example environment contained
-in arch/sandbox/board/env:
-
-@code
-# ./scripts/bareboxenv -s -p 0x10000 arch/sandbox/board/env/ env.bin
-@endcode
-
-To get some files to play with you can generate a cramfs image:
-
-@code
-# mkcramfs somedir/ cramfs.bin
-@endcode
-
-The @a barebox image is a normal Linux executable, so it can be started
-just like every other program:
-
-@code
-# ./barebox -e env.bin -i cramfs.bin
-
-barebox 2010.10.0 (Oct 29 2010 - 13:47:17)
-
-loading environment from /dev/env0
-barebox\> /
-@endcode
-
-Specifying -[ie] \<file\> tells @a barebox to map the file as a device
-under @p /dev. Files given with '-e' will appear as @p /dev/env[n]. Files
-given with '-i' will appear as @p /dev/fd[n].
-
-If @a barebox finds a valid configuration sector on @p /dev/env0, it
-will be loaded into @p /env and executes @p /env/init if existing.
-The default environment from the example above will show up a menu
-asking for the relevant settings.
-
-If you have started @a barebox as root you will find a new tap device on
-your host which you can configure using ifconfig. Once configured with
-valid network addresses, barebox can be used to ping the host machine or
-to fetch files with tftp.
-
-\todo Add more about tun/tap configuration
-
-If you have mapped a cramfs image, try mounting it with
-
-@code
-# mkdir /cram
-# mount /dev/fd0 cramfs /cram
-@endcode
-
-Memory can be examined using @p md/mw commands. They both understand the
--f \<file\> option to tell the commands that they should work on the
-specified files instead of @p /dev/mem (which holds the complete address
-space). Note that if you call 'md /dev/fd0' (without -f), @a barebox will
-segfault on the host, because it will interpret @p /dev/fd0 as a number.
-
-*/
diff --git a/Documentation/manual_org.dox b/Documentation/manual_org.dox
deleted file mode 100644
index 17238f0847..0000000000
--- a/Documentation/manual_org.dox
+++ /dev/null
@@ -1,27 +0,0 @@
-/** @page manual_org Organisation of this Manual
-
-There is no fixed organisation in this manual, as various source files forwards
-their content into different parts. So there are more visible menu entries,
-than listed here. But these files are the main control files:
-
- - Documentation
-  - Documentation/Doxyfile
-  - Documentation/barebox-main.dox
-   - Documentation/users_manual.dox
-    - Documentation/commands.dox
-   - Documentation/developers_manual.dox
-    - Documentation/board.dox
-    - arch/architecture.dox
-     - arch/arm/mach-arm.dox
-     - arch/blackfin/mach-bf.dox
-     - arch/ppc/mach-ppc.dox
-     - Documentation/parameters.dox
-   - Documentation/boards.dox
-    - various documentation files from the board directory
-
-New commands should forward their content to Documentation/commands.dox, so
-their pages should be listed in this file.
-
-New boards should forward their content to Documentation/boards.dox, so
-their pages should be listed in this file.
-*/
diff --git a/Documentation/users_manual.dox b/Documentation/users_manual.dox
deleted file mode 100644
index ea47b18724..0000000000
--- a/Documentation/users_manual.dox
+++ /dev/null
@@ -1,18 +0,0 @@
-/** @page users_manual User's Manual
-
-This manual provides help for working with @a Barebox from the user's
-point of view. So if you want to use @a Barebox for booting your target,
-you find a lot of nice tricks on these pages to make your life easier.
-
-@li @subpage building
-@li @subpage first_steps
-@li @subpage command_reference
-@li @subpage gpio_for_users
-
-\todo Rework the following sections
-@li @subpage shell_notes
-@li @subpage readline_parser
-@li @subpage x86_bootloader
-@li @subpage net_netconsole
-
-*/