source: README@ e2ec07a

1.0 2.3 2.3.x 2.4 ablfs ablfs-more legacy new_features trunk
Last change on this file since e2ec07a was bab90a1, checked in by George Boudreau <georgeb@…>, 18 years ago

Added a small note to README for the clfs'ers

  • Property mode set to 100644
File size: 7.2 KB
Line 
1$Id$
2
31. INTRODUCTION::
4
5 This collection of scripts, known as jhalfs, strives to create
6 accurate makefiles from the Linux From Scratch book series XML files.
7 This software is an evolution of the original "jhalfs-0.2" code.
8
9 The usage of this script assumes you have read and are familiar with
10 the book(s) and, therefore, the configuration variables found in config
11 files will have meaning to you. There are a number of command line switches
12 which, if used, will override the config file settings.
13
14 NOTES::
15 *. The resulting Makefile takes considerable time to run to completion.
16 Lay in a supply of caffeine beverages.
17
18 *. It is recommended that you temporarily unpack your linux kernel,
19 run <make menuconfig>, configure the kernel as per the book and save
20 the resulting .config file. This suggestion also applies to the
21 configuration of the uClibc package when building a HLFS system using
22 uClibc rather than glibc.
23
242. INSTALLATION::
25 No installation is required. System-wide installation is not allowed
26 for now.
27
283. CONFIGURATION FILES::
29 Each book in the LFS series has its own set of configurable parameters
30 as well as the common parameters file.
31
324. RUNNING::
33 The script master.sh cannot be invoked directly but only via the
34 supplied symlinks. After editing the config file for the project you wish
35 to build, run the script.
36
37 IMPORTANT:
38 If you use the switch -M (automatically run the generated makefile) you
39 must be 'root' or you can run the scripts using 'sudo'
40 i.e. sudo ./lfs -G -M
41
42 If you want to run make manually you can only do so if you are 'root' or
43 via 'sudo'
44 i.e (from within the jhalfs directory) sudo make
45
46 The term <symlink> refers to the 1 of 3 package symlinks, lfs,hlfs,clfs.
47 Replace <symlink> with your choice of packages; i.e.: ./lfs
48
49 ./<symlink> eg: ./lfs or ./hlfs
50 Create a makefile based on the settings found in the config files.
51 You must enter the build partition/jhalfs directory and manually run <make>
52
53 ./<symlink> -G eg: ./lfs -G
54 Download the packages and patches necessary to build <symlink>
55
56 ./<symlink> -G -M eg: ./lfs -G -M
57 Download the packages, create and automatically run the Makefile
58
59 ./<symlink> --help eg: ./lfs --help
60 will give you a context sensitive list of command line switches.
61
62 >>>> an expanded example
63
64 export SRC_ARCHIVE=/mnt/SourceFiles
65
66 ./lfs -D /mnt/partition4 \
67 -K ~/jhalfs_configs/linux-2.6.16.19-LFS.config \
68 -F ~/jhalfs-configs/fstab-sda3 \
69 -G -T 0 -M
70
71 explanation:::
72
73 export SRC_ARCHIVE=/mnt/SourceFiles
74 # This points to a local archive of existing packages. If the version in
75 the archive is incorrect jhalfs will access the net and download the
76 necessary version and store it here for later use. DO NOT set this to
77 $BUILDDIR/sources. If you do not set this variable to a valide directory
78 ALL package tarballs will be downloaded from the 'net.
79
80 -D /mnt/partition4
81 # where everything takes place. ..NOTE it must already exist and be mounted
82
83 -K ~/jhalfs_configs/linux-2.6.16.19-LFS.config
84 # If you want to automatically build a the kernel you MUST supply a valid
85 kernel configuration file. The file you supply will be copied and renamed.
86
87 -F ~/jhalfs-configs/fstab-sda3
88 # If you have a fstab file you wish to use it will be copied and renamed
89
90 -G # Retrieve the package files. You MUST enable this flag at least once if you
91 wish to do a build or whenever you update the book.
92
93 -T 0 # don't run any testsuites
94
95 -M # automatically run make against Makefile once jhalfs finishes its work.
96
97
985. LAYOUT::
99
100 /CLFS/config
101 /master.sh
102 /xxxx.xsl
103
104 /HLFS/config
105 /master.sh
106 /xxxx.xsl
107
108 /LFS/config
109 / master.sh
110 /xxxx.xsl
111
112 /common/config
113 /common_functions
114 /makefile_functions
115 /func_check_versions.sh
116 /func_validate_configs.sh
117
118 /contrib/jhalfs-paco.patch
119
120 /extras/do_copy_files
121 /do_ica_prep
122 /do_ica_work
123 /farce
124 /filelist
125
126 README
127 README.PACO
128 TODO
129
130 ./clfs ---|
131 ./hlfs ---|+---> master.sh
132 ./lfs ---|
133
134
1356. FAQ::
136 Q. "It doesn't work!"
137 A. Yes it does, try ./lfs --help
138
139 Q. "How do I specify the build location?"
140 A. The original LFS document worked against the well know location /mnt/lfs.
141 This script automates the build of all of the LFS series of books and uses
142 a generic location $BUILDDIR with a default value a /mnt/build_dir.
143 You may change this value to suit your needs.
144
145 The layout below $BUILDDIR is as follows.
146 $BUILDDIR/
147 jhalfs (makefile,cmd scripts,logs..etc)
148 sources (where packages reside)
149 tools (temporary bootstrap system)
150 cross-tools (temporary CLFS only)
151 ...
152 FHS dir structure
153 ...
154
155 Q. "What is the function of the SRC_ARCHIVE variable?"
156 A. When then symlinked master.sh runs it creates a local copy of the
157 necessary packages in BUILDDIR/sources by downloading the files. If
158 the variable SRC_ARCHIVE is defined the software will first look in
159 this location for the file and, if found, will copy it to BUILDDIR/sources.
160 If the files are not found in SRC_ARCHIVE _and_ you have write priv to
161 the directory any downloaded files will be mirrored there.
162
163 Q. "How do I set the SRC_ARCHIVE location?"
164 A. The best way to set the value of SRC_ARCHIVE is
165 export SRC_ARCHIVE=/wherever/you/store/downloaded/packages
166 OR
167 you can change the setting in .common/config.
168
169 Q. "Why have 2 copies of the files?"
170 A. The package files must be visible during the chroot phase and this is a
171 simple and reliable method of doing so. This method also handles the CLFS
172 build method where the final build may be done on a separate machine.
173
174 Q. "When I try to build 'xxx' with clfs the makefile fails at the mid-point"
175 A. There could be numerous reasons for the failure but the most likely reason
176 is you are doing a cross-build using the 'chroot' method and the target is
177 not compatible with the host. If you choose to build using the chroot
178 method a test is performed at the end of the temptools phase. If the test
179 succeeds the build continues inside a chroot jail. However if the test fails
180 it means the host and target are not compatible an you should use the
181 'boot' method to create your target code.
182 As an extreme example: You can build a sparc target on a x86 platform but
183 only the temptools phase. You must run ./clfs using the 'boot' method and
184 not the 'chroot.' You must transfer the toolchain to a sparc platform, reboot
185 the sparc box and continue the build.
186 Of all the LFS series of books the Cross-LFS requires the greatest
187 understanding of host/target hardware combination. Please read the book
188 carefully and don't skip the easy parts (there are none..)
189
190
191
192Authors:
193 George Boudreau
194 Manuel Canales Esparcia
195 Jeremy Huntwork
Note: See TracBrowser for help on using the repository browser.