source: README@ fe30c61

2.3 2.3.x 2.4 ablfs ablfs-more legacy new_features trunk
Last change on this file since fe30c61 was fe30c61, checked in by Manuel Canales Esparcia <manuel@…>, 18 years ago

Splitted common-functions.

  • Property mode set to 100644
File size: 9.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
272. PREREQUISITES::
28
29 To use this tool you MUST:
30
31 - have experience building {c,h,b}LFS packages
32 - know how to edit and write shell scripts
33 - know how a Makefile works
34 - be able to trace build failures and to find what is causing it
35 (user error, package bug, {c,h,b}LFS command bug, or jhalfs code bug)
36
37 If you do not have the above skills, please don't use this tool.
38
39
403. INSTALLATION::
41
42 No installation is required. System-wide installation is not allowed.
43
444. CONFIGURATION::
45
46 ::NEWS::
47 There is a new configuration method for jhalfs.
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 ::NEWS::
55 jhalfs is now launched via GNU make instead of individual symlinks.
56
57 The command <make> will launch a menu based configuration program. You will
58 recognize the layout from building the kernel or uClibc/BusyBox. The
59 underlying menu code was borrowed from BusyBox and slightly modified for
60 our use.
61
62 Help on parameter function is available from the online help. Please
63 make use of that feature for additional information not in this file.
64
65 Once you have set the parameters you wish and have saved your work the
66 jhalfs script is launch. The script verify first that the host can run
67 it and build the xLFS system, then validate the configuration and present
68 you with your selections which you may accept or reject.
69
70 If you accepted the displayed settings jhalfs will proceed to create the
71 Makefile, optionally download packages.
72
73 ::NEWS::
74 You must be logged as a normal user with sudo privileges to run
75 the Makefile.
76
77 NOTE::
78 If you run the jhalfs script directly the only function you can select
79 is to display the version number running <./jhalfs -v>
80
816. BLFS_TOOL SUPPORT::
82
83 For books that support it, there is an option to install blfs-tool and its
84 dependendencies on the final system.
85
86 After booting the new xLFS system some steps are needed to finish
87 blfs-tool installation:
88
89 - A user account must be created. You must be logged on that user
90 account to use blfs-tool.
91
92 - Move /blfs-root to that user's home and change ownership of the
93 directory and files to the user.
94
95 - Give the user read and write privileges over the $TRACKING_DIR
96 directory and the files that it contains.
97
98 - Configure sudo, adding the needed privileges for the user.
99
100 We assume that blfs-tool will be used on a running fresh xLFS system.
101 To use it to build BLFS packages from the chroot jail is also possible,
102 but is for you to figure out how to do that.
103
104 To know how to blfs-tool works, see README.BLFS.
105
1067. LAYOUT::
107
108 /BLFS (see README.BLFS)
109
110 /CLFS/master.sh
111 /clfs.xsl
112
113 /CLFS2/master.sh
114 /clfs2.xsl
115
116 /CLFS3/master.sh
117 /clfs3.xsl
118
119 /HLFS/master.sh
120 /hlfs.xsl
121
122 /LFS/master.sh
123 /lfs.xsl
124
125 /common/common_functions
126 /makefile_functions
127 /packages.xsl
128 /urls.xsl
129 /create-sbu_du-report.sh
130 /progress_bar.sh
131 /blfs-tool-deps/9xx-*
132 /libs/func_*
133
134 /contrib/jhalfs-paco.patch
135
136 /extras/do_copy_files
137 /do_ica_prep
138 /do_ica_work
139 /farce
140 /filelist
141
142 /optimize/opt_config
143 /opt_override
144 /optimize_functions
145 /opt_config.d/noOpt
146 /noSymbols
147 /O3pipe
148 /O3pipe_march
149 /defOpt_fPIC
150
151 /menu/*
152
153 README
154 README.BLFS
155 README.HLFS
156 README.PACO
157 TODO
158 LICENSE
159
160 Config.in
161 Makefile
162 jhalfs
163 blfs-tool
164
1658. FAQ::
166 Q. "This 'help' file is very sparse"
167 A. Yes, it is. This tool, jhalfs, is for those who understand the LFS books
168 and wish to automate the build. 99% of any problems that arise can be
169 solved by reading the book(s).
170
171 Q. "It doesn't work!"
172 A. Yes it does, try >> make
173 Remember you must have 'sudo' privileges.
174
175 Q. "It still doesn't work"
176 A. jhalfs was designed to work against the development versions of the LFS
177 series of books. Consequently changes in a book(s) sometimes breaks older
178 versions of jhalfs. Before you start pulling out your hair download the
179 latest version of jhalfs to see if that solves your problem.
180
181 Q. "How do I specify the build location?"
182 A. The original LFS document worked against the well known location /mnt/lfs.
183 This script automates the build of all of the LFS series of books and uses
184 a generic location $BUILDDIR with a default value of /mnt/build_dir.
185 You may change this value to suit your needs.
186
187 The layout below $BUILDDIR is as follows.
188 $BUILDDIR/
189 jhalfs (Makefile, cmd scripts, logs, etc..)
190 sources (where packages reside)
191 tools (temporary bootstrap system)
192 cross-tools (temporary CLFS only)
193 ...
194 FHS dir structure
195 ...
196 blfs_root (files to use blfs-tool if selected to install it)
197
198 Q. "What is the function of the SRC_ARCHIVE variable?"
199 A. When jhalfs runs and packages download was selected, it creates a local
200 copy of the necessary packages in BUILDDIR/sources by downloading the
201 files. If the variable SRC_ARCHIVE is defined the software will first
202 look in this location for the file and, if found, will copy it to
203 BUILDDIR/sources.
204 If the files are not found in SRC_ARCHIVE _and_ you have write priv to
205 the directory any downloaded files will be mirrored there.
206
207 Q. "How do I set the SRC_ARCHIVE location?"
208 A. The best way to set the value of SRC_ARCHIVE is
209
210 export SRC_ARCHIVE=/wherever/you/store/downloaded/packages
211
212 or you can set the full path in the proper menu entry.
213
214 Q. "Why have 2 copies of the files?"
215 A. The package files must be visible during the chroot phase and this is a
216 simple and reliable method of doing so. This method also handles the CLFS
217 boot build method where the final build may be done on a separate machine.
218
219 Q. "What is the function of "User account" and "Group account" menu settings?"
220 A. If you are running jhalfs from a low or non-privileged account you may not
221 have the priv to create/delete the user needed to build temporally tools.
222 These settings allow you to use your own user and group name to do that
223 build steps.
224
225 These variables are adjustable also when invoking make:
226
227 $BUILDDIR make LUSER=myaccount LGROUP=mygroup
228
229 The only changes to your account will be the creation of a NEW .bashrc
230 after saving your original to .bashrc.XXX
231
232 Q. "When I try to build CLFS the Makefile fails at the mid-point"
233 A. There could be numerous reasons for the failure but the most likely reason
234 is you are doing a cross-build using the 'chroot' method and the target is
235 not compatible with the host. If you choose to build using the chroot
236 method a test is performed at the end of the temptools phase. If the test
237 succeeds the build continues inside a chroot jail. However if the test fails
238 it means the host and target are not compatible an you should use the
239 'boot' method to create your target code.
240 As an extreme example: You can build a sparc target on a x86 platform but
241 only the temptools phase. You must select the 'boot' method and not the
242 'chroot.' You must transfer the toolchain to a sparc platform, reboot the
243 sparc box and continue the build.
244 Of all the LFS series of books Cross-LFS requires the greatest
245 understanding of host/target hardware combination. Please read the book
246 carefully and don't skip the easy parts (there are none..)
247
248Authors:
249 George Boudreau
250 Manuel Canales Esparcia
Note: See TracBrowser for help on using the repository browser.