diff options
Diffstat (limited to 'docs/using.txt')
| -rw-r--r-- | docs/using.txt | 50 |
1 files changed, 34 insertions, 16 deletions
diff --git a/docs/using.txt b/docs/using.txt index 7cf109609..96642f8e8 100644 --- a/docs/using.txt +++ b/docs/using.txt @@ -18,16 +18,29 @@ assistant: For each menu entry in the configuration tool, you can find associated help that describes the purpose of the entry. -image::menuconfig.png[] +image::openadk-menu.png[] -First of all you need to choose your target architecture, your target -system, your target C library, your target firmware type and your target -package format. After that you can select individual packages and kernel -settings or just use one of the predefined package collections. When you -are ready exit and save. You can always redefine the configuration -using +make menuconfig+. +First of all you need to choose if you want to build a Linux firmware +or a bare-metal toolchain. Linux is choosen as default. -image::menuconfig-configured.png[] +image::openadk-arch.png[] + +After that you should select your target architecture. + +image::openadk-system.png[] + +Now you can select your target system, endianess, cpu and other stuff. + +image::openadk-task.png[] + +If you want to compile some predefined appliance tasks, you can select it in +Tasks+. +You can later simply add your own tasks, which is a collection of options, packages, +kernel modules or features, runtime configuration and more. They can either be placed +inside the +tasks+ directory or in your own custom directory that you pass via ++ADK_CUSTOM_TASKS_DIR+ to make. + +When you are ready exit and save. You can always redefine the +configuration using +make menuconfig+. Once everything is configured, the configuration tool generates a +.config+ file that contains the description of your configuration. It @@ -57,9 +70,11 @@ OpenADK output is stored in several subdirectories: * +firmware/+ where all the images and packages are stored. -* +build_<system>_<arch>_<libc>/+ where all the components except for the cross-compilation toolchain are built. The directory contains one subdirectory for each of these components. +* +build_<system>_<libc>_<arch>_<abi>/+ where all the components except for the + cross-compilation toolchain are built. The directory contains one + subdirectory for each of these components. -* +target_<arch>_<libc>/+ which contains a hierarchy similar to a root filesystem +* +target_<system>_<libc>_<arch>_<abi>/+ which contains a hierarchy similar to a root filesystem hierarchy. This directory contains the installation of the cross-compilation toolchain and all the userspace packages selected for the target. However, this directory is 'not' intended to be @@ -69,7 +84,7 @@ OpenADK output is stored in several subdirectories: libraries and applications for the target that depend on other libraries. -* +root_<system>_<arch>_<libc>/+ which contains the complete root filesystem for +* +root_<system>_<libc>_<arch>_<abi>/+ which contains the complete root filesystem for the target. One exception, it doesn't have the correct permissions (e.g. setuid for the busybox binary) for some files. Therefore, this directory *should not be used on your target*. @@ -85,18 +100,21 @@ OpenADK output is stored in several subdirectories: * +host_<gnu_host_name>/+ contains the installation of tools compiled for the host that are needed for the proper execution of OpenADK -* +toolchain_<gnu_host_name>/+ contains just the cross-compilation toolchain. - Can be used together with +target_<arch>_<libc>/+ for other projects. Toolchain +* +host_build_<gnu_host_name>/+ contains the build directories of tools compiled for the host + that are needed for the proper execution of OpenADK + +* +toolchain_<system>_<libc>_<arch>_<abi>>/+ contains just the cross-compilation toolchain. + Can be used together with +target_<system>_<libc>_<arch>_<abi>/+ for other projects. Toolchain is relocatable. -* +toolchain_build_<arch>_<libc>/+ contains the build directories for the various +* +toolchain_build_<system>_<libc>_<arch>_<abi>/+ contains the build directories for the various components of the cross-compilation toolchain. -* +pkg_<system>_<arch>_<libc>/+ contains stamp files and file lists for the various components. +* +pkg_<system>_<libc>_<arch>_<abi>/+ contains stamp files and file lists for the various components. The command, +make menuconfig+ and +make+, are the basic ones that allow to easily and quickly generate images fitting -your needs, with all the supports and applications you enabled. +your needs, with all the applications you enabled. More details about the "make" command usage are given in xref:make-tips[]. |