source: README@ c93f2b0

2.3 2.3.x 2.4 ablfs ablfs-more legacy new_features trunk
Last change on this file since c93f2b0 was 52b0d10, checked in by George Boudreau <georgeb@…>, 17 years ago

BLFS book: progress_bar.sh, documentation and misc adjustments

  • Property mode set to 100644
File size: 10.1 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 - Configure sudo, adding the needed privileges for the user.
105
106 We assume that blfs-tool will be used on a running fresh xLFS system.
107 To use it to build BLFS packages from the chroot jail is also possible,
108 but is for you to figure out how to do that.
109
110 To know how to blfs-tool works, see README.BLFS.
111
1127. LAYOUT::
113
114 /BLFS (see README.BLFS)
115
116 /CLFS/master.sh
117 /clfs.xsl
118
119 /CLFS2/master.sh
120 /clfs2.xsl
121
122 /CLFS3/master.sh
123 /clfs3.xsl
124
125 /HLFS/master.sh
126 /hlfs.xsl
127
128 /LFS/master.sh
129 /lfs.xsl
130
131 /common/common_functions
132 /makefile_functions
133 /packages.xsl
134 /urls.xsl
135 /create-sbu_du-report.sh
136 /progress_bar.sh
137 /blfs-tool-deps/9xx-*
138 /libs/func_*
139
140 /custom/template
141 /config/
142 /examples/*
143 /examples_CLFS-E/*
144
145 /extras/do_copy_files
146 /do_ica_prep
147 /do_ica_work
148 /farce
149 /filelist
150
151 /optimize/opt_config
152 /opt_override
153 /optimize_functions
154 /opt_config.d/noOpt
155 /noSymbols
156 /O3pipe
157 /O3pipe_march
158 /defOpt_fPIC
159
160 /menu/*
161
162 README
163 README.BLFS
164 README.CLFS
165 README.HLFS
166 README.CUSTOM
167 TODO
168 LICENSE
169
170 Config.in
171 Makefile
172 jhalfs
173 blfs-tool
174
1758. FAQ::
176 Q. "This 'help' file is very sparse"
177 A. Yes, it is. This tool, jhalfs, is for those who understand the LFS books
178 and wish to automate the build. 99% of any problems that arise can be
179 solved by reading the book(s).
180
181 Q. "It doesn't work!"
182 A. Yes it does, try >> make
183 Remember you must have 'sudo' privileges.
184
185 Q. "It still doesn't work"
186 A. jhalfs was designed to work against the development versions of the LFS
187 series of books. Consequently changes in a book(s) sometimes breaks older
188 versions of jhalfs. Before you start pulling out your hair download the
189 latest version of jhalfs to see if that solves your problem.
190
191 Q. "How do I specify the build location?"
192 A. The original LFS document worked against the well known location /mnt/lfs.
193 This script automates the build of all of the LFS series of books and uses
194 a generic location $BUILDDIR with a default value of /mnt/build_dir.
195 You may change this value to suit your needs.
196
197 The layout below $BUILDDIR is as follows.
198 $BUILDDIR/
199 jhalfs (Makefile, cmd scripts, logs, etc..)
200 sources (where packages reside)
201 tools (temporary bootstrap system)
202 cross-tools (temporary CLFS only)
203 ...
204 FHS dir structure
205 ...
206 blfs_root (files to use blfs-tool if selected to install it)
207
208 Q. "What is the function of the SRC_ARCHIVE variable?"
209 A. When jhalfs runs and packages download was selected, it creates a local
210 copy of the necessary packages in BUILDDIR/sources by downloading the
211 files. If the variable SRC_ARCHIVE is defined the software will first
212 look in this location for the file and, if found, will copy it to
213 BUILDDIR/sources.
214 If the files are not found in SRC_ARCHIVE _and_ you have write priv to
215 the directory any downloaded files will be mirrored there.
216
217 Q. "How do I set the SRC_ARCHIVE location?"
218 A. The best way to set the value of SRC_ARCHIVE is
219
220 export SRC_ARCHIVE=/wherever/you/store/downloaded/packages
221
222 or you can set the full path in the proper menu entry.
223
224 Q. "Why have 2 copies of the files?"
225 A. The package files must be visible during the chroot phase and this is a
226 simple and reliable method of doing so. This method also handles the CLFS
227 boot build method where the final build may be done on a separate machine.
228
229 Q. "What is the function of "User account" and "Group account" menu settings?"
230 A. If you are running jhalfs from a low or non-privileged account you may not
231 have the priv to create/delete the user needed to build temporary tools.
232 These settings allow you to use your own user and group name to do that
233 build steps.
234
235 These variables are adjustable also when invoking make:
236
237 $BUILDDIR make LUSER=myaccount LGROUP=mygroup
238
239 The only changes to your account will be the creation of a NEW .bashrc
240 after saving your original to .bashrc.XXX
241
242 Q. "When I try to build CLFS the Makefile fails at the mid-point"
243 A. There could be numerous reasons for the failure but the most likely reason
244 is you are doing a cross-build using the 'chroot' method and the target is
245 not compatible with the host. If you choose to build using the chroot
246 method a test is performed at the end of the temptools phase. If the test
247 succeeds the build continues inside a chroot jail. However if the test fails
248 it means the host and target are not compatible an you should use the
249 'boot' method to create your target code.
250 As an extreme example: You can build a sparc target on a x86 platform but
251 only the temptools phase. You must select the 'boot' method and not the
252 'chroot.' You must transfer the toolchain to a sparc platform, reboot the
253 sparc box and continue the build.
254 Of all the LFS series of books Cross-LFS requires the greatest
255 understanding of host/target hardware combination. Please read the book
256 carefully and don't skip the easy parts (there are none..)
257
258 Q. "How could I stop the build at a predefined chosen point?"
259 A. Launch the Makefile manually passing the last numbered target to be build
260 as the break point. For example:
261
262 make BREAKPOINT=84-bash
263
264 The build can be stopped also at the end of a top-level build phase by
265 calling directly the appropriate mk_* target. For example:
266
267 make mk_LUSER
268
269 See the Makefile to know the proper target names for that book build.
270
271Authors:
272 George Boudreau
273 Manuel Canales Esparcia
Note: See TracBrowser for help on using the repository browser.