summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorWaldemar Brodkorb <wbx@openadk.org>2014-03-30 13:55:20 (GMT)
committerWaldemar Brodkorb <wbx@openadk.org>2014-03-30 13:55:20 (GMT)
commit8aed1fcd443b550c15a21ddbf1b1d3899803120a (patch)
treece7c0a22c1d5ed7d437198b4447a3aa2fd578665 /docs
parent12c9d74bb923174117e28186e4a7698e623803a2 (diff)
rework hosttools building, add tools into package stuff
Diffstat (limited to 'docs')
-rw-r--r--docs/how-openadk-works.txt25
-rw-r--r--docs/make-tips.txt4
-rw-r--r--docs/prerequisite.txt11
3 files changed, 16 insertions, 24 deletions
diff --git a/docs/how-openadk-works.txt b/docs/how-openadk-works.txt
index a8634d8..e862511 100644
--- a/docs/how-openadk-works.txt
+++ b/docs/how-openadk-works.txt
@@ -6,7 +6,7 @@ How OpenADK works
As mentioned above, OpenADK is basically a set of Makefiles that
download, configure, and compile software with the correct options. It
-also includes patches for various software packages and the linux kernel.
+also includes patches for various software packages and the Linux kernel.
There is basically one Makefile per software package. Makefiles are split into
many different parts.
@@ -22,28 +22,20 @@ many different parts.
the kernel patches
* The +package/+ directory contains the Makefiles and
- associated files for all user-space tools and libraries that OpenADK
- can compile and add to the target root filesystem. There is one
- sub-directory per package.
+ associated files for all user-space tools and libraries that OpenADK can
+ compile and add to the target root filesystem or to the host directory. There
+ is one sub-directory per package.
* The +mk/+ directory contains some globally used Makefiles with
the suffix +.mk+, these are used in all other Makefile via include
-* The +tools/+ directory contains the Makefiles and
+* The +adk/+ directory contains the Makefiles and
associated files for software related to the generation of the
- host tools needed for different tasks (compression tools, ..).
-
-There are three other directories in the top level directory of OpenADK:
+ host tools needed for +make menuconfig+ system
* The +scripts/+ directory contains shell scripts for the creation of
meta-data in OpenADK, install scripts and image creation scripts
-* The +config/+ directory contains the application used for the
- +make menuconfig+ system
-
-* The +tests/+ directory contains some data for the +make check+ target,
- to run the gcc testsuite
-
The main Makefile performs the following steps before the configuration
is done:
@@ -69,12 +61,13 @@ configuration is done (it is mainly a wrapper for +mk/build.mk+):
available systems and package collections
* Generate the host tools required for different tasks (encrypting passwords,
- compressing data, extracting archives, ..)
+ compressing data, extracting archives, creating images, ..)
* Generate the cross-compilation toolchain (binutils, gcc, libc, gdb)
-* Compile the linux kernel
+* Compile the Linux kernel
* Compile all the userspace packages, the boot loader and external kernel modules
* Generate the firmware images or archives
+
diff --git a/docs/make-tips.txt b/docs/make-tips.txt
index f508633..dcfbe22 100644
--- a/docs/make-tips.txt
+++ b/docs/make-tips.txt
@@ -43,7 +43,7 @@ and pkg trees, the firmware and the toolchain for all targets):
--------------------
If you even want to clean any downloaded source and your
-confiuration +.config+:
+configuration +.config+:
--------------------
$ make distclean
@@ -60,7 +60,7 @@ This is automatically triggered if you change the kernel version in
your configuration.
If you just want to clean all packages and wants to rebuild the firmware,
-(the tools/toolchain is not deleted) just use:
+(the toolchain is not deleted) just use:
--------------------
$ make clean
diff --git a/docs/prerequisite.txt b/docs/prerequisite.txt
index 8a96700..d7ffcc5 100644
--- a/docs/prerequisite.txt
+++ b/docs/prerequisite.txt
@@ -23,8 +23,8 @@ package names may vary between host systems.
** +bash+
** +binutils+
-** +gcc+
-** `g++`
+** +C compiler (gcc or clang)+
+** `C++ compiler (g++ or clang++)`
** +GNU sed+
** +GNU awk+
** +GNU make+
@@ -33,10 +33,9 @@ package names may vary between host systems.
** +perl+
** +tar+
** +wget+
-** +findutils (find, xargs)+
-** +ncurses5 development+
-** +zlib development+
-** +libc development+
+** +ncurses5 development files+
+** +zlib development files+
+** +libc development files+
There is a check for the required versions of these tools in advance,
though. To re-issue the checks, use +make prereq+.