annotate sources/README @ 1187:878dbfe76341

Move $BUILD/logs creation from record-commands.sh to include.sh so it gets reliably recreated when a user blanks the logs and re-runs.
author Rob Landley <rob@landley.net>
date Sun, 01 Aug 2010 15:19:00 -0500
parents bd2ea96aac53
children 7d086d8fa348
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
966
bd2ea96aac53 Update READMEs.
Rob Landley <rob@landley.net>
parents: 888
diff changeset
8 utility-functions.sh: Functions usable in contexts other than the FWL build,
bd2ea96aac53 Update READMEs.
Rob Landley <rob@landley.net>
parents: 888
diff changeset
9 included from functions.sh.
bd2ea96aac53 Update READMEs.
Rob Landley <rob@landley.net>
parents: 888
diff changeset
10
858
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
11 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
12
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
13 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
14 that don't work on all targets.
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
15
871
b274eb556b50 Merge common uclibc miniconfig stuff into baseconfig-uClibc, and add the few lines that vary per target to each target's settings file.
Rob Landley <rob@landley.net>
parents: 858
diff changeset
16 baseconfig-uClibc: Common miniconfig shared by all architectures, to which
b274eb556b50 Merge common uclibc miniconfig stuff into baseconfig-uClibc, and add the few lines that vary per target to each target's settings file.
Rob Landley <rob@landley.net>
parents: 858
diff changeset
17 $UCLIBC_CONFIG from the target/$ARCH/settings is appended.
b274eb556b50 Merge common uclibc miniconfig stuff into baseconfig-uClibc, and add the few lines that vary per target to each target's settings file.
Rob Landley <rob@landley.net>
parents: 858
diff changeset
18
858
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
19 The following subdirectories live here:
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
20
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
21 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
22 This directory contains external user interfaces, just obscure ones.
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
23
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
24 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
25
888
626288dd5cf3 Lots of comments.
Rob Landley <rob@landley.net>
parents: 871
diff changeset
26 toys: Various small code snippets written or maintained for this project.
858
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
27
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
28 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
29 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
30
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
31 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
32 Each package has "$PACKAGE-*.patch" applied in alphabetical order,
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
33 or "alt-$PACKAGE-*.patch" for USE_UNSTABLE versions.
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 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
36 and getconfig() in functions.sh. Each subdirectory is a
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
37 target name, and contains at least four files:
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 settings: Environment variables needed by the build.
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
40
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
41 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
42 (If miniconfig-alt-linux exists, USE_UNSTABLE=linux
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
43 will use that instead.)
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
44
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
45 miniconfig-uClibc: uClibc .config compressed by toys/miniconfig.sh
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
46 (If miniconfig-alt-uClibc exists, USE_UNSTABLE=uClibc
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
47 will use that instead.)
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
48
eda31d43d89f The sources directory needs a README.
Rob Landley <rob@landley.net>
parents:
diff changeset
49 description: Simple documentation about the platform