comparison sources/README @ 858:eda31d43d89f

The sources directory needs a README.
author Rob Landley <rob@landley.net>
date Sat, 24 Oct 2009 18:37:09 -0500
parents
children b274eb556b50
comparison
equal deleted inserted replaced
857:eee8e9fcb1dd 858:eda31d43d89f
1 The following files live here:
2
3 include.sh: Common code included by every build stage. Defines many
4 environment variables.
5
6 functions.sh: Function definitions, normally included from include.sh.
7
8 timeout.sh: Wrapper to run a command line with a timeout.
9
10 trimconfig-busybox: Busybox config file to switch off bits of "allyesconfig"
11 that don't work on all targets.
12
13 The following subdirectories live here:
14
15 more: Additional scripts the user can run, but which aren't part of build.sh.
16 This directory contains external user interfaces, just obscure ones.
17
18 native: Files copied verbatim into each architecture's root-filesystem image.
19
20 toys: Various small code snippets written or maintained by this project.
21
22 sections: Package build scripts called more than once during build.sh.
23 This is duplicate code factored out into a common location.
24
25 patches: Patches applied to the packages listed in download.sh by "setupfor".
26 Each package has "$PACKAGE-*.patch" applied in alphabetical order,
27 or "alt-$PACKAGE-*.patch" for USE_UNSTABLE versions.
28
29 targets: Configuration for each target platform, parsed by read_arch_dir()
30 and getconfig() in functions.sh. Each subdirectory is a
31 target name, and contains at least four files:
32
33 settings: Environment variables needed by the build.
34
35 miniconfig-linux: linux kernel .config compressed by toys/miniconfig.sh
36 (If miniconfig-alt-linux exists, USE_UNSTABLE=linux
37 will use that instead.)
38
39 miniconfig-uClibc: uClibc .config compressed by toys/miniconfig.sh
40 (If miniconfig-alt-uClibc exists, USE_UNSTABLE=uClibc
41 will use that instead.)
42
43 description: Simple documentation about the platform