diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/adding-packages-host.txt | 14 | ||||
| -rw-r--r-- | docs/contribute.txt | 1 | ||||
| -rw-r--r-- | docs/getting.txt | 6 | ||||
| -rw-r--r-- | docs/how-openadk-works.txt | 25 | ||||
| -rw-r--r-- | docs/introduction.txt | 6 | ||||
| -rw-r--r-- | docs/make-tips.txt | 4 | ||||
| -rw-r--r-- | docs/patch-policy.txt | 12 | ||||
| -rw-r--r-- | docs/prerequisite.txt | 11 |
8 files changed, 41 insertions, 38 deletions
diff --git a/docs/adding-packages-host.txt b/docs/adding-packages-host.txt index a858d4563..c9eba6d02 100644 --- a/docs/adding-packages-host.txt +++ b/docs/adding-packages-host.txt @@ -75,18 +75,12 @@ Following mix between host and target package is possible, too: 29: include ${TOPDIR}/mk/pkg-bottom.mk ------------------------ -It is important to have foo-host as package build dependency, see line 12, so that the order is always build the host package -and then the target package. -If you need to rebuild a mixed package, you are advised to use: +If you need to rebuild a mixed package, you can do: ------------ - $ make package=<package> clean hostpackage package + $ make package=<package> hostclean hostpackage clean package ------------ -At the moment there is one limitation regarding the recursive dependency resolving. It is just not implemented, yet. -So you always need to set +PKG_BUILDDEP+ to all host tools dependencies in the right order. If package foo needs host -tool bar, and host tool bar needs host library libbaz, you have to use following +PKG_BUILDDEP+ variable: +If your host package have some dependencies, use following: ------------ - PKG_BUILDDEP:=libbaz-host bar-host + HOST_BUILDDEP:=libbaz-host bar-host ------------ - - diff --git a/docs/contribute.txt b/docs/contribute.txt index 909263886..5a8e1fdd8 100644 --- a/docs/contribute.txt +++ b/docs/contribute.txt @@ -82,6 +82,7 @@ Here is a short list of details to provide in such case: * target for which the build fails * package(s) which the build fails * the command that fails and its output +* the make.log file, generated when make v is used * any information you think that may be relevant Additionally, you can add the +.config+ file. diff --git a/docs/getting.txt b/docs/getting.txt index 534ba99c9..0902bb6e0 100644 --- a/docs/getting.txt +++ b/docs/getting.txt @@ -5,8 +5,9 @@ Getting OpenADK --------------- -OpenADK does not have any releases. Only direct Git -access is possible. +OpenADK does not have any releases. We are following the +http://en.wikipedia.org/wiki/Rolling_release[rolling release] +development model. To download OpenADK using Git just do: @@ -20,3 +21,4 @@ Or if you prefer HTTP or using Git behind a proxy: $ git clone http://git.openadk.org/openadk.git --------------------- +Or you can get a http://www.openadk.org/snapshots/[snapshot]. diff --git a/docs/how-openadk-works.txt b/docs/how-openadk-works.txt index a8634d8c3..e86251196 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/introduction.txt b/docs/introduction.txt index 991747672..3489c9d5f 100644 --- a/docs/introduction.txt +++ b/docs/introduction.txt @@ -24,3 +24,9 @@ processors, MIPS processors, ARM processors, etc. OpenADK supports numerous processors and their variants; it also comes with default configurations for some embedded systems and netbooks. (Raspberry PI, Sharp Zaurus, Lemote Yeelong, IBM X40 and more) + +OpenADK is not a Linux distribution and there are no releases or binary +packages available. If you need something like that, better switch to +something else. OpenADK builds everything from source. There are only a +few exceptions to this rule (f.e. some bootloaders and firmware files for +wireless network cards). diff --git a/docs/make-tips.txt b/docs/make-tips.txt index f508633e9..dcfbe22e0 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/patch-policy.txt b/docs/patch-policy.txt index b5a585b5e..e948661cf 100644 --- a/docs/patch-policy.txt +++ b/docs/patch-policy.txt @@ -10,8 +10,8 @@ While integrating a new package or updating an existing one, it may be necessary to patch the source of the software to get it cross-built within OpenADK. OpenADK offers an infrastructure to automatically handle this during the builds. Patches are provided within OpenADK, in the package directory; -these typically aim to fix cross-compilation, libc support, or other such -issues. +these typically aim to fix cross-compilation, libc support, portability issues +or other things. Normally the patches are autogenerated via: ------------ @@ -80,3 +80,11 @@ Fetch from: <some url> It is also sensible to add a few words about any changes to the patch that may have been necessary. + +Upstreaming patches +~~~~~~~~~~~~~~~~~~~ + +OpenADK tries to avoid any patches to the source code. If a patch could +not be avoided, it should be tried to make the patch of a good quality to +get it upstream. OpenADK tries to report any found issues and try to send +in any upstream compatible patches. diff --git a/docs/prerequisite.txt b/docs/prerequisite.txt index 8a9670066..d7ffcc544 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+. |