source: README@ 608fbe1

2.4 ablfs ablfs-more legacy new_features trunk
Last change on this file since 608fbe1 was 339fd84, checked in by Manuel Canales Esparcia <manuel@…>, 17 years ago

Updated blfs-tool dependencies.

  • Property mode set to 100644
File size: 10.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 developed
8 by Jeremy Huntwork.
9
10 The usage of this script assumes you have read and are familiar with
11 the book(s) and, therefore, the configuration variables found in menuconfig
12 interface will have meaning to you.
13
14 The list of supported books can be found at
15 http://wiki.linuxfromscratch.org/alfs/wiki/SupportedBooks
16
17 NOTES::
18 *. The resulting Makefile takes considerable time to run to completion.
19 Lay in a supply of caffeine beverages.
20
21 *. It is recommended that you temporarily unpack your linux kernel,
22 run <make menuconfig>, configure the kernel as per the book and save
23 the resulting .config file. This suggestion also applies to the
24 configuration of the uClibc package when building a HLFS system using
25 uClibc rather than glibc.
26
27 *. Read carefully this file and the other README.* files before start
28 using the tool.
29
302. PREREQUISITES::
31
32 To use this tool you MUST:
33
34 - have experience building {c,h,b}LFS packages
35 - know how to edit and write shell scripts
36 - know how a Makefile works
37 - be able to trace build failures and to find what is causing it
38 (user error, package bug, {c,h,b}LFS command bug, or jhalfs code bug)
39
40 If you do not have the above skills, please don't use this tool.
41
42
433. INSTALLATION::
44
45 No installation is required. System-wide installation is not allowed.
46
474. CONFIGURATION::
48
49 We have installed the familiar menu based configuration tool driven by
50 GNU make. see the section RUNNING, for details
51
525. RUNNING::
53
54 The command <make> will launch a menu based configuration program. You will
55 recognize the layout from building the kernel or uClibc/BusyBox. The
56 underlying menu code was borrowed from BusyBox and slightly modified for
57 our use.
58
59 Help on parameter function is available from the on-line help. Please
60 make use of that feature for additional information not in this file.
61
62 Once you have set the parameters you wish and have saved your work the
63 jhalfs script is launch. The script verify first that the host can run
64 it and build the xLFS system, then validate the configuration and present
65 you with your selections which you may accept or reject.
66
67 If you accepted the displayed settings jhalfs will proceed to create the
68 Makefile, optionally download packages.
69
70 ::NEWS::
71 You must be logged as a normal user with sudo privileges to run
72 the Makefile.
73
74 NOTE::
75 If you run the jhalfs script directly the only function you can select
76 is to display the version number running <./jhalfs -v>
77
786. BLFS_TOOL SUPPORT::
79
80 For books that support it, there is an option to install blfs-tool and its
81 dependencies on the final system. The pre-made build dependencies
82 scripts has been written based on a LFS build. For CLFS and HLFS
83 builds you may need to adjust that scripts, that are found into the
84 common/blfs-tool-deps directory in the jhalfs sources tree.
85
86 WARNING:: If you add blfs-tool support on a CLFS Sysroot build
87 you MUST to edit the dependencies scripts to fix the
88 installation paths.
89 Be careful when you modify the scripts as you can
90 easily disable the host system.
91
92 After booting the new xLFS system some steps are needed to finish
93 blfs-tool installation:
94
95 - A user account must be created. You must be logged on that user
96 account to use blfs-tool.
97
98 - Move /blfs-root to that user's home and change ownership of the
99 directory and files to the user.
100
101 - Give the user read and write privileges over the $TRACKING_DIR
102 directory and the files that it contains.
103
104 - If you think that you may need the libxml2/libxslt Python modules,
105 remove the libxml2 and libxslt trackin files found in $TRACKING_DIR.
106
107 - Configure sudo, adding the needed privileges for the user.
108
109 We assume that blfs-tool will be used on a running fresh xLFS system.
110 To use it to build BLFS packages from the chroot jail is also possible,
111 but is for you to figure out how to do that.
112
113 To know how to blfs-tool works, see README.BLFS.
114
1157. LAYOUT::
116
117 /BLFS (see README.BLFS)
118
119 /CLFS/master.sh
120 /clfs.xsl
121
122 /CLFS2/master.sh
123 /clfs2.xsl
124
125 /CLFS3/master.sh
126 /clfs3.xsl
127
128 /HLFS/master.sh
129 /hlfs.xsl
130
131 /LFS/master.sh
132 /lfs.xsl
133
134 /common/common_functions
135 /makefile_functions
136 /packages.xsl
137 /urls.xsl
138 /create-sbu_du-report.sh
139 /progress_bar.sh
140 /blfs-tool-deps/9xx-*
141 /libs/func_*
142
143 /custom/template
144 /config/
145 /examples/*
146 /examples_CLFS-E/*
147
148 /extras/do_copy_files
149 /do_ica_prep
150 /do_ica_work
151 /farce
152 /filelist
153
154 /optimize/opt_config
155 /opt_override
156 /optimize_functions
157 /opt_config.d/noOpt
158 /noSymbols
159 /O3pipe
160 /O3pipe_march
161 /defOpt_fPIC
162
163 /menu/*
164
165 README
166 README.BLFS
167 README.CLFS
168 README.HLFS
169 README.CUSTOM
170 TODO
171 LICENSE
172
173 Config.in
174 Makefile
175 jhalfs
176 blfs-tool
177
1788. FAQ::
179 Q. "This 'help' file is very sparse"
180 A. Yes, it is. This tool, jhalfs, is for those who understand the LFS books
181 and wish to automate the build. 99% of any problems that arise can be
182 solved by reading the book(s).
183
184 Q. "It doesn't work!"
185 A. Yes it does, try >> make
186 Remember you must have 'sudo' privileges.
187
188 Q. "It still doesn't work"
189 A. jhalfs was designed to work against the development versions of the LFS
190 series of books. Consequently changes in a book(s) sometimes breaks older
191 versions of jhalfs. Before you start pulling out your hair download the
192 latest version of jhalfs to see if that solves your problem.
193
194 Q. "How do I specify the build location?"
195 A. The original LFS document worked against the well known location /mnt/lfs.
196 This script automates the build of all of the LFS series of books and uses
197 a generic location $BUILDDIR with a default value of /mnt/build_dir.
198 You may change this value to suit your needs.
199
200 The layout below $BUILDDIR is as follows.
201 $BUILDDIR/
202 jhalfs (Makefile, cmd scripts, logs, etc..)
203 sources (where packages reside)
204 tools (temporary bootstrap system)
205 cross-tools (temporary CLFS only)
206 ...
207 FHS dir structure
208 ...
209 blfs_root (files to use blfs-tool if selected to install it)
210
211 Q. "What is the function of the SRC_ARCHIVE variable?"
212 A. When jhalfs runs and packages download was selected, it creates a local
213 copy of the necessary packages in BUILDDIR/sources by downloading the
214 files. If the variable SRC_ARCHIVE is defined the software will first
215 look in this location for the file and, if found, will copy it to
216 BUILDDIR/sources.
217 If the files are not found in SRC_ARCHIVE _and_ you have write priv to
218 the directory any downloaded files will be mirrored there.
219
220 Q. "How do I set the SRC_ARCHIVE location?"
221 A. The best way to set the value of SRC_ARCHIVE is
222
223 export SRC_ARCHIVE=/wherever/you/store/downloaded/packages
224
225 or you can set the full path in the proper menu entry.
226
227 Q. "Why have 2 copies of the files?"
228 A. The package files must be visible during the chroot phase and this is a
229 simple and reliable method of doing so. This method also handles the CLFS
230 boot build method where the final build may be done on a separate machine.
231
232 Q. "What is the function of "User account" and "Group account" menu settings?"
233 A. If you are running jhalfs from a low or non-privileged account you may not
234 have the priv to create/delete the user needed to build temporary tools.
235 These settings allow you to use your own user and group name to do that
236 build steps.
237
238 These variables are adjustable also when invoking make:
239
240 $BUILDDIR make LUSER=myaccount LGROUP=mygroup
241
242 The only changes to your account will be the creation of a NEW .bashrc
243 after saving your original to .bashrc.XXX
244
245 Q. "When I try to build CLFS the Makefile fails at the mid-point"
246 A. There could be numerous reasons for the failure but the most likely reason
247 is you are doing a cross-build using the 'chroot' method and the target is
248 not compatible with the host. If you choose to build using the chroot
249 method a test is performed at the end of the temptools phase. If the test
250 succeeds the build continues inside a chroot jail. However if the test fails
251 it means the host and target are not compatible an you should use the
252 'boot' method to create your target code.
253 As an extreme example: You can build a sparc target on a x86 platform but
254 only the temptools phase. You must select the 'boot' method and not the
255 'chroot.' You must transfer the toolchain to a sparc platform, reboot the
256 sparc box and continue the build.
257 Of all the LFS series of books Cross-LFS requires the greatest
258 understanding of host/target hardware combination. Please read the book
259 carefully and don't skip the easy parts (there are none..)
260
261 Q. "How could I stop the build at a predefined chosen point?"
262 A. Launch the Makefile manually passing the last numbered target to be build
263 as the break point. For example:
264
265 make BREAKPOINT=84-bash
266
267 The build can be stopped also at the end of a top-level build phase by
268 calling directly the appropriate mk_* target. For example:
269
270 make mk_LUSER
271
272 See the Makefile to know the proper target names for that book build.
273
274Authors:
275 George Boudreau
276 Manuel Canales Esparcia
Note: See TracBrowser for help on using the repository browser.