summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/overview.txt30
1 files changed, 12 insertions, 18 deletions
diff --git a/docs/overview.txt b/docs/overview.txt
index f7cf10a..5ff9d61 100644
--- a/docs/overview.txt
+++ b/docs/overview.txt
@@ -541,20 +541,14 @@ An architecture is defined by:
- a human-readable name, in lower case letters, with numbers as appropriate.
The underscore is allowed; space and special characters are not.
Eg.: arm, x86_64
- - a directory in "config/arch/" named after the architecture, with the same
- letters as above. Eg.: arch/arm, arch/x86_64
- This directory contains the following files, and only those files:
- - a configuration file in kconfig syntax, named "config.in", which shall
- follow the API defined below.
- Eg.: config/arch/arm/config.in
- - a function script in bash-3.0 syntax, named "functions", which shall
- follow the API defined below.
- Eg.: config/arch/arm/functions
- - an optional file, named "experimental" (in lower case!), which, if it
- is present, means that support for this architecture is EXPERIMENTAL.
- Eg.: config/arch/arm/experimental
-
-The "config.in" file API:
+ - a file in "config/arch/", named after the architecture's name, and suffixed
+ with ".in".
+ Eg.: config/arch/arm.in
+ - a file in "scripts/build/arch/", named after the architecture's name, and
+ suffixed with ".sh".
+ Eg.: scripts/build/arch/arm.sh
+
+The architecture's ".in" file API:
> the config option "ARCH_%arch%" (where %arch% is to be replaced with the
actual architecture name).
That config option must have *neither* a type, *nor* a prompt! Also, it can
@@ -584,7 +578,7 @@ The "config.in" file API:
this, as the architecture name was written all upper case. However, the
prefix is unique among architectures, and does not cause harm).
-The "functions" file API:
+The architecture's ".sh" file API:
> the function "CT_DoArchValues"
+ parameters: none
+ environment:
@@ -656,8 +650,8 @@ The "functions" file API:
- default to:
- all empty
-You can have a look at "config/arch/arm/" for an quite complete example of
-what an actual architecture description looks like.
+You can have a look at "config/arch/arm.in" and "scripts/build/arch/arm.sh" for
+a quite complete example of what an actual architecture description looks like.
Kernel specific |
----------------+
@@ -760,7 +754,7 @@ The kernel's ".sh" file API:
any name-clashing.
You can have a look at "config/kernel/linux.in" and "scripts/build/kernel/linux.sh"
-as an example of what a complex kernel description looks like,
+as an example of what a complex kernel description looks like.
Adding a new version of a component |
------------------------------------+