diff options
| author | Sascha Hauer <s.hauer@pengutronix.de> | 2014-06-17 10:27:03 +0200 |
|---|---|---|
| committer | Sascha Hauer <s.hauer@pengutronix.de> | 2014-06-26 10:09:52 +0200 |
| commit | 98360be0fefd58bf27df03c47d887dd676a31d73 (patch) | |
| tree | 76447f0ee3d99f3864bdfb9952178affb5dc9f76 /Documentation/building.dox | |
| parent | 7b82f548580fb52023ed2116784632fd996a51fc (diff) | |
| download | barebox-98360be0fefd58bf27df03c47d887dd676a31d73.tar.gz barebox-98360be0fefd58bf27df03c47d887dd676a31d73.tar.xz | |
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>
Diffstat (limited to 'Documentation/building.dox')
| -rw-r--r-- | Documentation/building.dox | 60 |
1 files changed, 0 insertions, 60 deletions
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 - -*/ |