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