source: README@ 86d7ef3

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

Redaction fix.

  • Property mode set to 100644
File size: 8.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
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
81
826. LAYOUT::
83
84 /BLFS (see README.BLFS)
85
86 /CLFS/master.sh
87 /clfs.xsl
88
89 /CLFS2/master.sh
90 /clfs2.xsl
91
92 /HLFS/master.sh
93 /hlfs.xsl
94
95 /LFS/master.sh
96 /lfs.xsl
97
98 /common/common_functions
99 /makefile_functions
100 /func_check_versions.sh
101 /func_validate_configs.sh
102 /packages.xsl
103 /urls.xsl
104 /create-sbu_du-report.sh
105 /func_compare.sh
106 /progress_bar.sh
107 /blfs-tool-deps/9xx-*
108
109 /contrib/jhalfs-paco.patch
110
111 /extras/do_copy_files
112 /do_ica_prep
113 /do_ica_work
114 /farce
115 /filelist
116
117 /optimize/opt_config
118 /opt_override
119 /optimize_functions
120 /opt_config.d/noOpt
121 /noSymbols
122 /O3pipe
123 /O3pipe_march
124 /defOpt_fPIC
125
126 /menu/*
127
128 README
129 README.BLFS
130 README.HLFS
131 README.PACO
132 TODO
133 LICENSE
134
135 Config.in
136 Makefile
137 jhalfs
138 blfs-tool
139
1407. FAQ::
141 Q. "This 'help' file is very sparse"
142 A. Yes, it is. This tool, jhalfs, is for those who understand the LFS books
143 and wish to automate the build. 99% of any problems that arise can be
144 solved by reading the book(s).
145
146 Q. "It doesn't work!"
147 A. Yes it does, try >> make
148 Remember you must have 'sudo' privileges.
149
150 Q. "It still doesn't work"
151 A. jhalfs was designed to work against the development versions of the LFS
152 series of books. Consequently changes in a book(s) sometimes breaks older
153 versions of jhalfs. Before you start pulling out your hair download the
154 latest version of jhalfs to see if that solves your problem.
155
156 Q. "How do I specify the build location?"
157 A. The original LFS document worked against the well known location /mnt/lfs.
158 This script automates the build of all of the LFS series of books and uses
159 a generic location $BUILDDIR with a default value of /mnt/build_dir.
160 You may change this value to suit your needs.
161
162 The layout below $BUILDDIR is as follows.
163 $BUILDDIR/
164 jhalfs (Makefile, cmd scripts, logs, etc..)
165 sources (where packages reside)
166 tools (temporary bootstrap system)
167 cross-tools (temporary CLFS only)
168 ...
169 FHS dir structure
170 ...
171 blfs_root (files to use blfs-tool if selected to install it)
172
173 Q. "What is the function of the SRC_ARCHIVE variable?"
174 A. When jhalfs runs and packages download was selected, it creates a local
175 copy of the necessary packages in BUILDDIR/sources by downloading the
176 files. If the variable SRC_ARCHIVE is defined the software will first
177 look in this location for the file and, if found, will copy it to
178 BUILDDIR/sources.
179 If the files are not found in SRC_ARCHIVE _and_ you have write priv to
180 the directory any downloaded files will be mirrored there.
181
182 Q. "How do I set the SRC_ARCHIVE location?"
183 A. The best way to set the value of SRC_ARCHIVE is
184
185 export SRC_ARCHIVE=/wherever/you/store/downloaded/packages
186
187 or you can set the full path in the proper menu entry.
188
189 Q. "Why have 2 copies of the files?"
190 A. The package files must be visible during the chroot phase and this is a
191 simple and reliable method of doing so. This method also handles the CLFS
192 boot build method where the final build may be done on a separate machine.
193
194 Q. "What is the function of "User account" and "Group account" menu settings?"
195 A. If you are running jhalfs from a low or non-privileged account you may not
196 have the priv to create/delete the user needed to build temporally tools.
197 These settings allow you to use your own user and group name to do that
198 build steps.
199
200 These variables are adjustable also when invoking make:
201
202 $BUILDDIR make LUSER=myaccount LGROUP=mygroup
203
204 The only changes to your account will be the creation of a NEW .bashrc
205 after saving your original to .bashrc.XXX
206
207 Q. "When I try to build CLFS the Makefile fails at the mid-point"
208 A. There could be numerous reasons for the failure but the most likely reason
209 is you are doing a cross-build using the 'chroot' method and the target is
210 not compatible with the host. If you choose to build using the chroot
211 method a test is performed at the end of the temptools phase. If the test
212 succeeds the build continues inside a chroot jail. However if the test fails
213 it means the host and target are not compatible an you should use the
214 'boot' method to create your target code.
215 As an extreme example: You can build a sparc target on a x86 platform but
216 only the temptools phase. You must select the 'boot' method and not the
217 'chroot.' You must transfer the toolchain to a sparc platform, reboot the
218 sparc box and continue the build.
219 Of all the LFS series of books Cross-LFS requires the greatest
220 understanding of host/target hardware combination. Please read the book
221 carefully and don't skip the easy parts (there are none..)
222
223Authors:
224 George Boudreau
225 Manuel Canales Esparcia
Note: See TracBrowser for help on using the repository browser.