summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorWaldemar Brodkorb <wbx@uclibc-ng.org>2015-12-14 04:48:49 (GMT)
committerWaldemar Brodkorb <wbx@uclibc-ng.org>2015-12-14 04:51:13 (GMT)
commit66ecf28c5960f02f1c3f2c61d369034f41be09eb (patch)
tree12ebaa94dacf865c6e51643bcd01fad9503806e6 /docs
parentece758372ca0fe88b50bfabea2d7ea78a88aab4b (diff)
docs: refresh to latest ADK changes
Diffstat (limited to 'docs')
-rw-r--r--docs/adding-boards.txt6
-rw-r--r--docs/configure.txt5
-rw-r--r--docs/contribute.txt7
-rw-r--r--docs/how-openadk-works.txt31
-rw-r--r--docs/prerequisite.txt21
-rw-r--r--docs/running-openadk.txt2
-rw-r--r--docs/using.txt6
-rw-r--r--docs/working-with.txt3
-rw-r--r--docs/writing-rules.txt7
9 files changed, 40 insertions, 48 deletions
diff --git a/docs/adding-boards.txt b/docs/adding-boards.txt
index 7522c53..4066fd8 100644
--- a/docs/adding-boards.txt
+++ b/docs/adding-boards.txt
@@ -93,10 +93,10 @@ wget https://www.kernel.org/pub/linux/kernel/v3.x/linux-3.18.9.tar.xz
tar xvf linux-3.18.9.tar.xz
find linux-3.18.9 linux-rpi -type l -delete
rm -rf linux-rpi/.git
-diff -Nur linux-3.18.9 linux-rpi > target/arm/bcm28xx/patches/3.18.9/0000-raspberry-pi.patch
+diff -Nur linux-3.18.9 linux-rpi > target/arm/bcm28xx/patches/3.18.9/0001-bcm28xx-github.patch
------------------------
-Normally you use target/<arch>/<target system>/patches/<kernelversion>/0000-<target-system>.patch.
+Normally you use target/<arch>/<target system>/patches/<kernelversion>/0001-<target-system>.patch.
In case of Raspberry PI 2 we have a single patch for Raspberry PI and Raspberry PI 2 and use
the extra board name bcm28xx to describe the family of devices.
@@ -129,4 +129,4 @@ We use the symbol prefix ADK_KERNEL instead of CONFIG. Otherwise the symbols are
matching the kernel symbol names.
Get again into the menu based system, enable the driver you added and recompile.
-If your driver is available as kernel module use tristate.
+If your driver is available as a kernel module use tristate.
diff --git a/docs/configure.txt b/docs/configure.txt
index 3726478..9414302 100644
--- a/docs/configure.txt
+++ b/docs/configure.txt
@@ -40,8 +40,9 @@ toolchain runs on x86 and generates code for ARM.
You can choose between three C libraries:
http://www.uclibc-ng.org[uClibc-ng],
-http://www.gnu.org/software/libc/libc.html[glibc] and
-http://www.musl-libc.org[musl].
+http://www.gnu.org/software/libc/libc.html[glibc],
+http://www.musl-libc.org[musl] and
+https://sourceware.org/newlib/[newlib].
There are some configuration options provided in +Toolchain settings+.
You can enable or disable the building of following components and toolchain
diff --git a/docs/contribute.txt b/docs/contribute.txt
index 5a8e1fd..cdd66bb 100644
--- a/docs/contribute.txt
+++ b/docs/contribute.txt
@@ -7,7 +7,8 @@ Contributing to OpenADK
If you want to contribute to OpenADK, you will need a git view of
the project. Refer to xref:getting-openadk[] to get it.
-Currently a mail to wbx@openadk.org is the central place for contribution.
+You can either subscribe to the mailing list dev@openadk.org or
+send an email directly to wbx@openadk.org.
[[submitting-patches]]
Submitting patches
@@ -35,10 +36,10 @@ This will generate patch files automatically adding the +Signed-off-by+ line.
Once patch files are generated, you can review/edit the commit message
before submitting them using your favorite text editor.
-Lastly, send/submit your patch set to the OpenADK developer:
+Lastly, send/submit your patch set to the OpenADK developers:
---------------------
-$ git send-email --to wbx@openadk.org *.patch
+$ git send-email --to dev@openadk.org *.patch
---------------------
Note that +git+ should be configured to use your mail account.
diff --git a/docs/how-openadk-works.txt b/docs/how-openadk-works.txt
index acafc75..fa4b98c 100644
--- a/docs/how-openadk-works.txt
+++ b/docs/how-openadk-works.txt
@@ -19,7 +19,7 @@ many different parts.
* The +target/+ directory contains the definitions for all the processor
architectures that are supported by OpenADK. +target/linux+ contains
the meta-data for the Linux kernel configuration abstraction layer and
- the kernel patches
+ the kernel patches.
* The +package/+ directory contains the Makefiles and
associated files for all user-space tools and libraries that OpenADK can
@@ -27,38 +27,35 @@ many different parts.
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 suffix +.mk+, these are used in all other Makefiles via include.
* The +adk/+ directory contains the Makefiles and
associated files for software related to the generation of the
- host tools needed for +make menuconfig+ system
+ 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
+ meta-data in OpenADK, install scripts and image creation scripts.
-The main Makefile performs the following steps before the configuration
-is done:
+The configuration process is separated in following steps:
-* Call the +prereq+ target to check if the host system have all required
- software installed. It creates the +prereq.mk+ Makefile.
+* Makefile is just a wrapper which calls the prerequisite shell script.
+
+* The prerequisite shell script +scripts/prereq.sh+ checks if the host
+ system have all required software installed and tries to build GNU make
+ and bash if it is missing. It creates the +prereq.mk+ Makefile.
* Compile and run the OpenADK tools to generate the meta-data for the menu
based configuration and creates the +package/Depends.mk+ Makefile to handle the
- dependencies
+ dependencies.
-* Starts the menu based configuration system via +make menuconfig+
+* Starts the menu based configuration system via +make menuconfig+.
-The main Makefile performs the following steps, once the
-configuration is done (it is mainly a wrapper for +mk/build.mk+):
+The following steps are performed, once the configuration is done
+(mainly implemented in +mk/build.mk+):
* Create all the output directories: +host_<gnu_host_name>+, +target_<arch>_<libc>+,
+build_<arch>_<libc>+, +pkg_<arch>_<libc>+, etc.
-* Call the +scan-pkgs.sh+ script to find any needed optional host software, needed to compile
- software the user has configured
-
-* Call the +create-menu+ script to generate meta-data for available systems and package collections
-
* Generate the host tools required for different tasks (encrypting passwords,
compressing data, extracting archives, creating images, ..)
diff --git a/docs/prerequisite.txt b/docs/prerequisite.txt
index 8209abb..997659c 100644
--- a/docs/prerequisite.txt
+++ b/docs/prerequisite.txt
@@ -6,10 +6,9 @@ System requirements
-------------------
OpenADK is designed to run on Linux systems. But there is basic
-support to run on MacOS X Maverick, Windows 7 with Cygwin, OpenBSD,
-NetBSD and FreeBSD. Main development happens on Debian/GNU Linux 7
-and MacOS X Maverick. The other host platforms are occasionally
-tested.
+support to run on MacOS X, Windows with Cygwin, OpenBSD, MirBSD,
+NetBSD and FreeBSD. Main development happens on Debian/GNU Linux
+and MacOS X. The other host platforms are occasionally tested.
OpenADK detects the host system and displays only the software
packages, which are known to be cross-compilable on the used host.
@@ -21,28 +20,22 @@ package names may vary between host systems.
* Build tools:
-** +bash+
** +binutils+
** +C compiler (gcc or clang)+
** `C++ compiler (g++ or clang++)`
-** +GNU make+
+** +make+
** +gzip+
** +perl+
** +tar+
-** +wget+
-** +ncurses5 development files+
-** +zlib development files+
+** +curl or wget+
+** +ncurses 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+.
+though.
For some packages there are some optional packages required. OpenADK
will check for the required tools in advance, when a specific package is
choosen. For example Kodi needs Java installed on the host system.
OpenADK tries to avoid any optional required host tools and will try to
build them when needed.
-
-For some host systems you can try to use ./scripts/adkprepare.sh to
-install all required software. You need to run the script as root, it
-will use the package management of your host to install the software.
diff --git a/docs/running-openadk.txt b/docs/running-openadk.txt
index dcc7cee..545fa05 100644
--- a/docs/running-openadk.txt
+++ b/docs/running-openadk.txt
@@ -29,7 +29,7 @@ be by default compressed with xz compression algorithm, if available for
the target system. You can configure the compression algorithm used for the
compression of the Linux kernel and if choosen the initramfs filesystem in
+make menuconfig+. In +Kernel configuration+ you have the choice between
-dfferent kernel versions. The latest version will be automatically used.
+dfferent kernel versions. The latest stable OpenADK version will be automatically used.
There you can choose any needed addon drivers or any supported runtime
and debugging features.
diff --git a/docs/using.txt b/docs/using.txt
index 0157891..b91e588 100644
--- a/docs/using.txt
+++ b/docs/using.txt
@@ -22,12 +22,12 @@ image::openadk-appliance.png[]
First of all you need to choose a new or predefined appliance.
This is a collection of different packages and configuration options
-for specific appliance.
+for a specific appliance.
image::openadk-target.png[]
After that you can choose your target architecture, your target system and
-other general stuff. Then you can select individual packages and kernel
+other general stuff. Then you can select individual packages and kernel
settings. When you are ready exit and save. You can always redefine the
configuration using +make menuconfig+.
@@ -103,7 +103,7 @@ OpenADK output is stored in several subdirectories:
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[].
diff --git a/docs/working-with.txt b/docs/working-with.txt
index 9e101d2..2bc155b 100644
--- a/docs/working-with.txt
+++ b/docs/working-with.txt
@@ -21,5 +21,6 @@ Hacking OpenADK
If OpenADK does not yet fit all your requirements, you may be
interested in hacking it to add:
-* new packages: refer to the xref:adding-packages[Developer guide]
+* new embedded targets: refer to the xref:adding-boards[Adding new boards]
+* new packages: refer to the xref:adding-packages[Adding new packages]
diff --git a/docs/writing-rules.txt b/docs/writing-rules.txt
index e24ff4a..60f496e 100644
--- a/docs/writing-rules.txt
+++ b/docs/writing-rules.txt
@@ -21,8 +21,7 @@ An entry has the following pattern:
---------------------
config ADK_TARGET_FOO
- prompt "foo"
- boolean
+ bool "foo"
select BR2_PACKAGE_LIBBAR
depends on ADK_PACKAGE_LIBBAZ
default n
@@ -32,14 +31,14 @@ config ADK_TARGET_FOO
http://foo.org/foo/
---------------------
-* The +boolean+, +depends on+, +default+, +select+ and +help+ lines are indented
+* The +bool+, +depends on+, +default+, +select+ and +help+ lines are indented
with one tab.
* The help text itself should be indented with one tab and two
spaces.
The +Config.in+ files are the input for the configuration tool
-used in OpenADK, which is the regular _Kconfig_. For further
+used in OpenADK, which is an enhanced version of _Kconfig_. For further
details about the _Kconfig_ language, refer to
http://kernel.org/doc/Documentation/kbuild/kconfig-language.txt[].