source: README@ 323f805

experimental
Last change on this file since 323f805 was 9485eba, checked in by George Boudreau <georgeb@…>, 18 years ago

Implement suggestion made byDan Nicholson for configurable user/group. Required many changes and allowed for the removal of user specific function calls. Tnx Dan

  • Property mode set to 100644
File size: 9.2 KB
Line 
1$Id$
2
31. INTRODUCTION::
4
5 This collection of scripts, known as jhalfs-X, 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
32 ::NEWS:: There is new configuration method for jhalfs.
33
34 We have installed the familiar menu based configuration tool driven by
35 make. If you type the command
36 make
37 you will be presented with a list of configurable parameters (starting
38 with the book you wish to use). All the parameters found in the individual
39 config files are available. Once you have finished setting the parameters
40 and exit the make file will launch the chosen book version of jhalfs.
41 JHALFS will import your created file and overider the values found in normal
42 "config" files.
43 ..note.. The generated file <configuration> is only used by jhalfs if you
44 run jhalfs via make otherwise it is ignored.
45
46 If you want to try out the new configuration system without running jhalfs
47 issue the following.
48 make menuconfig
49 This will create a new file named configuration but will not launch jhalfs.
50
514. RUNNING::
52 The script master.sh cannot be invoked directly but only via the
53 supplied symlinks. After editing the config file for the project you wish
54 to build, run the script.
55
56 IMPORTANT:
57 If you use the switch -M (automatically run the generated makefile) you
58 must be 'root' or you can run the scripts using 'sudo'
59 i.e. sudo ./lfs -G -M
60
61 If you want to run make manually you can only do so if you are 'root' or
62 via 'sudo'
63 i.e (from within the jhalfs directory) sudo make
64
65 The term <symlink> refers to the 1 of 3 package symlinks, lfs,hlfs,clfs.
66 Replace <symlink> with your choice of packages; i.e.: ./lfs
67
68 ./<symlink> eg: ./lfs or ./hlfs
69 Create a makefile based on the settings found in the config files.
70 You must enter the build partition/jhalfs directory and manually run <make>
71
72 ./<symlink> -G eg: ./lfs -G
73 Download the packages and patches necessary to build <symlink>
74
75 ./<symlink> -G -M eg: ./lfs -G -M
76 Download the packages, create and automatically run the Makefile
77
78 ./<symlink> --help eg: ./lfs --help
79 will give you a context sensitive list of command line switches.
80
81 >>>> an expanded example
82
83 export SRC_ARCHIVE=/mnt/SourceFiles
84
85 ./lfs -D /mnt/partition4 \
86 -K ~/jhalfs_configs/linux-2.6.16.19-LFS.config \
87 -F ~/jhalfs-configs/fstab-sda3 \
88 -G -T 0 -M
89
90 explanation:::
91
92 export SRC_ARCHIVE=/mnt/SourceFiles
93 # This points to a local archive of existing packages. If the version in
94 the archive is incorrect jhalfs will access the net and download the
95 necessary version and store it here for later use. DO NOT set this to
96 $BUILDDIR/sources. If you do not set this variable to a valid directory
97 ALL package tarballs will be downloaded from the 'net.
98
99 -D /mnt/partition4
100 # where everything takes place. ..NOTE it must already exist and be mounted
101
102 -K ~/jhalfs_configs/linux-2.6.16.19-LFS.config
103 # If you want to automatically build a the kernel you MUST supply a valid
104 kernel configuration file. The file you supply will be copied and renamed.
105
106 -F ~/jhalfs-configs/fstab-sda3
107 # If you have a fstab file you wish to use it will be copied and renamed
108
109 -G # Retrieve the package files. You MUST enable this flag at least once if you
110 wish to do a build or whenever you update the book.
111
112 -T 0 # don't run any testsuites
113
114 -M # automatically run make against Makefile once jhalfs finishes its work.
115
116
1175. LAYOUT::
118
119 /CLFS/config
120 /master.sh
121 /xxxx.xsl
122
123 /CLFS2/config
124 /master.sh
125 /xxxx.xsl
126
127 /HLFS/config
128 /master.sh
129 /xxxx.xsl
130
131 /LFS/config
132 / master.sh
133 /xxxx.xsl
134
135 /common/config
136 /common_functions
137 /makefile_functions
138 /func_check_versions.sh
139 /func_validate_configs.sh
140
141 /contrib/jhalfs-paco.patch
142
143 /extras/do_copy_files
144 /do_ica_prep
145 /do_ica_work
146 /farce
147 /filelist
148
149 README
150 README.PACO
151 TODO
152
153 ./clfs ---|
154 ./clfs2 ---|
155 ./hlfs ---|+---> master.sh
156 ./lfs ---|
157
158
1596. FAQ::
160 Q. "This 'help' file is very sparse"
161 A. Yes, it is. This tool, jhalfs, is for those who understand the LFS books
162 and wish to automate the build. 99% of any problems that arise can be
163 solved by reading the book(s).
164
165 Q. "It doesn't work!"
166 A. Yes it does, try ./lfs --help
167 Remember you must either be 'root' to run this script or have 'sudo' privileges.
168
169 Q. "It still doesn't work"
170 A. jhalfs was designed to work against the developement versions of the LFS
171 series of books. Consequently changes in a book(s) sometimes breaks older
172 versions of jhalfs. Before you start pulling out your hair download the
173 latest version of jhalfs to see if that solves your problem.
174
175 Q. "How do I specify the build location?"
176 A. The original LFS document worked against the well known location /mnt/lfs.
177 This script automates the build of all of the LFS series of books and uses
178 a generic location $BUILDDIR with a default value of /mnt/build_dir.
179 You may change this value to suit your needs.
180
181 The layout below $BUILDDIR is as follows.
182 $BUILDDIR/
183 jhalfs (makefile,cmd scripts,logs..etc)
184 sources (where packages reside)
185 tools (temporary bootstrap system)
186 cross-tools (temporary CLFS only)
187 ...
188 FHS dir structure
189 ...
190
191 Q. "What is the function of the SRC_ARCHIVE variable?"
192 A. When then symlinked master.sh runs it creates a local copy of the
193 necessary packages in BUILDDIR/sources by downloading the files. If
194 the variable SRC_ARCHIVE is defined the software will first look in
195 this location for the file and, if found, will copy it to BUILDDIR/sources.
196 If the files are not found in SRC_ARCHIVE _and_ you have write priv to
197 the directory any downloaded files will be mirrored there.
198
199 Q. "How do I set the SRC_ARCHIVE location?"
200 A. The best way to set the value of SRC_ARCHIVE is
201 export SRC_ARCHIVE=/wherever/you/store/downloaded/packages
202 OR
203 you can change the setting in common/config.
204
205 Q. "Why have 2 copies of the files?"
206 A. The package files must be visible during the chroot phase and this is a
207 simple and reliable method of doing so. This method also handles the CLFS
208 build method where the final build may be done on a separate machine.
209
210 Q. "What is the function of LUSER and LGROUP? There is no cmd line switch"
211 A. If you are running jhalfs from a low or non-priveledged account you may not
212 have the priv to create/delete accounts. These variables are adjustable
213 when invoking make.
214 make LUSER=myaccount LGROUP=mygroup
215 Then only changes to your account will be the creation of a NEW .bashrc after
216 saving your original to .bashrc.XXX
217
218 Q. "When I try to build 'xxx' with clfs the makefile fails at the mid-point"
219 A. There could be numerous reasons for the failure but the most likely reason
220 is you are doing a cross-build using the 'chroot' method and the target is
221 not compatible with the host. If you choose to build using the chroot
222 method a test is performed at the end of the temptools phase. If the test
223 succeeds the build continues inside a chroot jail. However if the test fails
224 it means the host and target are not compatible an you should use the
225 'boot' method to create your target code.
226 As an extreme example: You can build a sparc target on a x86 platform but
227 only the temptools phase. You must run ./clfs using the 'boot' method and
228 not the 'chroot.' You must transfer the toolchain to a sparc platform, reboot
229 the sparc box and continue the build.
230 Of all the LFS series of books Cross-LFS requires the greatest
231 understanding of host/target hardware combination. Please read the book
232 carefully and don't skip the easy parts (there are none..)
233
234Authors:
235 George Boudreau
236 Manuel Canales Esparcia
237 Jeremy Huntwork
Note: See TracBrowser for help on using the repository browser.