docs/overview.txt
changeset 383 f00eb97ff649
parent 381 6a0ee764a60a
child 387 2fa4b675a9a3
     1.1 --- a/docs/overview.txt	Fri Sep 14 19:30:56 2007 +0000
     1.2 +++ b/docs/overview.txt	Fri Sep 14 21:17:59 2007 +0000
     1.3 @@ -485,23 +485,42 @@
     1.4       follow the API defined below. Eg.: arch/arm/functions
     1.5  
     1.6  The "functions" file API:
     1.7 - > the function "CT_DoBuildTargetTuple"
     1.8 + > the function "CT_DoArchValues"
     1.9     + parameters: none
    1.10     + environment:
    1.11        - all variables from the ".config" file,
    1.12        - the two variables "target_endian_eb" and "target_endian_el" which are
    1.13 -        the endiannes suffixes
    1.14 +        the endianness suffixes
    1.15     + return value: 0 upon success, !0 upon failure
    1.16     + provides:
    1.17 -     - the target tuple stored in the variable CT_TARGET_ARCH
    1.18 -
    1.19 - > the environment variable CT_ARCH_ENDIAN_OPT
    1.20 -   + contains:
    1.21 -     - the value of the CFLAGS values for selecting the endiannes (eg.: -ml
    1.22 -       for a Super-H little endian, -mbig-endian for an ARM big endian).
    1.23 -     - empty if the architecture can not set the endianness (eg x86 and
    1.24 -       x86_64).
    1.25 -
    1.26 +     - the environment variable CT_TARGET_ARCH
    1.27 +     - mandatory
    1.28 +     - contains:
    1.29 +       the architecture part of the target tuple.
    1.30 +       Eg.: "armeb" for big endian ARM
    1.31 +            "i386" for an i386
    1.32 +   + provides:
    1.33 +     - the environment variable CT_TARGET_ARCH
    1.34 +     - optional
    1.35 +     - contain:
    1.36 +       the sytem part of the target tuple.
    1.37 +       Eg.: "gnu" for glibc on most architectures
    1.38 +            "gnueabi" for glibc on an ARM EABI
    1.39 +     - defaults to:
    1.40 +       - for glibc-based toolchain: "gnu"
    1.41 +       - for uClibc-based toolchain: "uclibc"
    1.42 +   + provides:
    1.43 +     - the environment variable CT_ARCH_ENDIAN_OPT
    1.44 +     - optional
    1.45 +     - contains:
    1.46 +       the compiler option to set the endianness.
    1.47 +       Eg.: "-ml" for a Super-H little endian
    1.48 +            "-mbig-endian" for an ARM big endian
    1.49 +            /empty/ for x86 and x86_64
    1.50 +     - defaults to:
    1.51 +       - for bi-endian big endian architectures: "-mbig-endian"
    1.52 +       - for bi-endian little endian architectures: "-mlittle-endian"
    1.53 +       - for single-endian architectures: /empty/
    1.54  
    1.55  Build scripts |
    1.56  --------------*