diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/adding-boards.txt | 2 | ||||
| -rw-r--r-- | docs/adding-packages-auto.txt | 2 | ||||
| -rw-r--r-- | docs/adding-packages-manual.txt | 2 | ||||
| -rw-r--r-- | docs/common-usage.txt | 2 | ||||
| -rw-r--r-- | docs/customize-rootfs.txt | 2 | ||||
| -rw-r--r-- | docs/introduction.txt | 10 | ||||
| -rw-r--r-- | docs/package-reference.txt | 12 | ||||
| -rw-r--r-- | docs/running-openadk.txt | 53 |
8 files changed, 53 insertions, 32 deletions
diff --git a/docs/adding-boards.txt b/docs/adding-boards.txt index df102a5e6..5f50df702 100644 --- a/docs/adding-boards.txt +++ b/docs/adding-boards.txt @@ -44,7 +44,7 @@ in OpenADK, you need to port it first. The hardware capabilities are optional. (f.e. ADK_TARGET_WITH_SD), but required when you configure the driver configuration later. -For architectures with a choice for endianess you should depends on either +For architectures with a choice for endianess you should depend on either ADK_TARGET_LITTLE_ENDIAN or ADK_TARGET_BIG_ENDIAN. If the CPU type like in this example ADK_TARGET_CPU_ARM_CORTEX_A7 is not yet available diff --git a/docs/adding-packages-auto.txt b/docs/adding-packages-auto.txt index b84ce0a9f..4bfb2e439 100644 --- a/docs/adding-packages-auto.txt +++ b/docs/adding-packages-auto.txt @@ -49,7 +49,7 @@ package buildtime dependencies (+PKG_BUILDDEP+), the package runtime dependencies (+PKG_DEPENDS+), the package homepage (+PKG_URL+) and finally the internet locations at which the tarball can be downloaded from (+PKG_SITES+). Normally ${PKG_NAME}-${PKG_VERSION}.tar.gz will be downloaded. You can -overwrite the default via the +DISTFILES+ variable. You can add more then one +override the default via the +DISTFILES+ variable. You can add more then one archive name in +DISTFILES+ via space separated. If you have no source archive at all, just use the boolean variable +NO_DISTFILES+ and set it to 1. diff --git a/docs/adding-packages-manual.txt b/docs/adding-packages-manual.txt index 862662987..768d3cdb6 100644 --- a/docs/adding-packages-manual.txt +++ b/docs/adding-packages-manual.txt @@ -60,7 +60,7 @@ package buildtime dependencies (+PKG_BUILDDEP+), the package runtime dependencies (+PKG_DEPENDS+), the package homepage (+PKG_URL+) and finally the internet locations at which the tarball can be downloaded from (+PKG_SITES+). Normally ${PKG_NAME}-${PKG_VERSION}.tar.gz will be downloaded. You can -overwrite the default via the +DISTFILES+ variable. You can add more then one +override the default via the +DISTFILES+ variable. You can add more then one archive name in +DISTFILES+ via space separated. If you have no source archive at all, just use the boolean variable +NO_DISTFILES+ and set it to 1. diff --git a/docs/common-usage.txt b/docs/common-usage.txt index b2f29f6cc..25cc22454 100644 --- a/docs/common-usage.txt +++ b/docs/common-usage.txt @@ -9,7 +9,7 @@ Understanding when a full rebuild is necessary OpenADK tries to detect what part of the system should be rebuilt when the system configuration is changed through +make menuconfig+. In some cases it -automatically rebuilt packages, but sometimes just a warning is printed to the +automatically rebuilds packages, but sometimes just a warning is printed to the terminal, that a rebuild is necessary to make the changes an effect. If strange things are happening, the autodetection might have not worked correctly, then you should consider to rebuild everything. If you are following development you diff --git a/docs/customize-rootfs.txt b/docs/customize-rootfs.txt index 54846dba5..3d4f0bf7b 100644 --- a/docs/customize-rootfs.txt +++ b/docs/customize-rootfs.txt @@ -25,5 +25,5 @@ loss of customized configuration data. Another option is to configure a post-build action. This is available in +Global settings+. It must point to a script relative to the root of your openadk working copy. It will be invoked as part of the -+*-imageinstall+ step with $ADK_TOPDIR as first argument. You can use ++-imageinstall+ step with $ADK_TOPDIR as first argument. You can use it e.g. to modify the +root_*+ filesystem before bundling it. diff --git a/docs/introduction.txt b/docs/introduction.txt index 3c858e7b8..8bab44a38 100644 --- a/docs/introduction.txt +++ b/docs/introduction.txt @@ -24,14 +24,14 @@ without need for Linux as operating system. Embedded systems often use processors that are not the regular x86 processors everyone is used to having in his PC. -OpenADK supports 40 different architectures: -AARCH64, Alpha, ARC, ARM, AVR32, Blackfin, C6X, CR16, CRIS, Epiphany, FR-V, -H8/300, HPPA, IA64, LM32, M32R, M68K, METAG, Microblaze, MIPS, MIPS64, MN10300, -Moxie, MSP430, NDS32, NIOS2, OR1K, PPC, PPC64, RiscV, RX, S/390, SH, SPARC, SPARC64, Tile, +OpenADK supports 44 different architectures: +AARCH64, Alpha, ARC, ARM, AVR32, Blackfin, C6X, CR16, CRIS, C-SKY, Epiphany, FR-V, FT32, +H8/300, HPPA, IA64, LM32, M32C, M32R, M68K, METAG, Microblaze, MIPS, MIPS64, MN10300, +Moxie, MSP430, NDS32, NIOS2, OR1K, PPC, PPC64, RISCV32, RISCV64, RX, S/390, SH, SPARC, SPARC64, Tile, V850, X86, X86_64 and Xtensa. OpenADK supports numerous processors and their variants; it also comes -with sample configurations for many embedded systems, emulators and netbooks. +with sample configurations for many embedded systems and emulators. OpenADK is not a Linux distribution and there are no releases or binary packages available. If you need something like that, better switch to diff --git a/docs/package-reference.txt b/docs/package-reference.txt index a57fbd033..29c4208d0 100644 --- a/docs/package-reference.txt +++ b/docs/package-reference.txt @@ -104,7 +104,7 @@ different steps of the configure, build and install process. * +MAKE_ENV+ add additional variables to build step -* +MAKE_FLAGS+ add additinal make flags to build step +* +MAKE_FLAGS+ add additional make flags to build step * +FAKE_FLAGS+ add additional make flags to fake install step @@ -112,15 +112,15 @@ different steps of the configure, build and install process. * +INSTALL_STYLE+ either manual or auto -* +CONFIGURE_PROG+ overwrite default configure programm +* +CONFIGURE_PROG+ override default configure program -* +MAKE_FILE+ overwrite default Makefile +* +MAKE_FILE+ override default Makefile -* +ALL_TARGET+ overwrite default build target +* +ALL_TARGET+ override default build target -* +INSTALL_TARGET+ overwrite default install target +* +INSTALL_TARGET+ override default install target -The variables to add or overwrite preprocessor, compiler and linker flags: +The variables to add or override preprocessor, compiler and linker flags: * +TARGET_CPPFLAGS+ flags for the preprocessor diff --git a/docs/running-openadk.txt b/docs/running-openadk.txt index dcfd7451d..205b0d292 100644 --- a/docs/running-openadk.txt +++ b/docs/running-openadk.txt @@ -60,8 +60,6 @@ OpenADK is generated while producing the +base-files+ package. The main job the default inittab does is to start the +/etc/init.d/rcS+ shell script, and start one or more +getty+ programs (which provides a login prompt). -Support for systemd and s6 is very experimental at the moment. - /dev management ~~~~~~~~~~~~~~~ @@ -73,19 +71,21 @@ hardware devices, even if they are properly recognized by the Linux kernel. In OpenADK you can choose between different types of device managements. -OpenADK defaults to *dynamic device nodes using devtmpfs and mdev*. This method -relies on the _devtmpfs_ virtual filesystem in the kernel, which is enabled by -default for all OpenADK generated kernels, and adds the +mdev+ userspace -utility on top of it. +mdev+ is a program part of Busybox that the kernel will -call every time a device is added or removed. Thanks to the +/etc/mdev.conf+ -configuration file, +mdev+ can be configured to for example, set specific -permissions or ownership on a device file, call a script or application -whenever a device appears or disappear, etc. Basically, it allows _userspace_ -to react on device addition and removal events. +mdev+ is also important if you -have devices that require a firmware, as it will be responsible for pushing the -firmware contents to the kernel. +mdev+ is a lightweight implementation (with -fewer features) of +udev+. For more details about +mdev+ and the syntax of its -configuration file, see http://git.busybox.net/busybox/tree/docs/mdev.txt. +OpenADK defaults to *static device nodes using devtmpfs*. That is the simplest +way available. Most users might like to change it to *dynamic device nodes +using devtmpfs and mdev*. This method relies on the _devtmpfs_ virtual +filesystem in the kernel, which is enabled by default for all OpenADK generated +kernels, and adds the +mdev+ userspace utility on top of it. +mdev+ is a +program part of Busybox that the kernel will call every time a device is added +or removed. Thanks to the +/etc/mdev.conf+ configuration file, +mdev+ can be +configured to for example, set specific permissions or ownership on a device +file, call a script or application whenever a device appears or disappear, etc. +Basically, it allows _userspace_ to react on device addition and removal +events. +mdev+ is also important if you have devices that require a firmware, +as it will be responsible for pushing the firmware contents to the kernel. ++mdev+ is a lightweight implementation (with fewer features) of +udev+. For +more details about +mdev+ and the syntax of its configuration file, see +http://git.busybox.net/busybox/tree/docs/mdev.txt. initscripts ~~~~~~~~~~~ @@ -179,8 +179,29 @@ In both cases the default user is +root+ and the default password is either via +passwd+ on the system or you can preconfigure a password via +make menuconfig+ under +Runtime configuration+. -The default shell used in OpenADK is +mksh+ from http://www.mirbsd.org/mksh/. +The default shell used in OpenADK is +mksh+ from http://www.mirbsd.org/mksh.htm. You can change the shell in +make menuconfig+ under +Runtime configuration+. Be aware of the fact that the bootup process might use some +mksh+ features to speedup the system start. When you change the shell for system +/bin/sh+ the slower startup is used as a fallback. + +analyzing logs +~~~~~~~~~~~~~~ + +Since embedded systems usually avoid writing continously on non-volatile storage +(to avoid waer-out of the storage device) there are no logfiles under /var/log and +/var itself is mapped onto a RAM based filesystem. + +Instead the syslog daemon logs into a ciruclar memory +buffer. The size of the memory buffer is by default 32KiB and can be changed in the +busybox configuration. + +To access the content of the buffer the +logread+ utility is used to dump the buffer. +To get a continous output of the logbuffer -f has to be added as option. + +--------------------- +Usage: logread [-fF] + +-f Output data as log grows +-F Same as -f, but dump buffer first +--------------------- |