source: README@ 30d4061

2.3 2.3.x 2.4 ablfs ablfs-more legacy new_features trunk
Last change on this file since 30d4061 was cbc8ba2, checked in by George Boudreau <georgeb@…>, 18 years ago

Corrections to blfs-tools scripts. Added missing tidy_docs download and code

  • Property mode set to 100644
File size: 7.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.
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.
12
13 NOTES::
14 *. The resulting Makefile takes considerable time to run to completion.
15 Lay in a supply of caffeine beverages.
16
17 *. It is recommended that you temporarily unpack your linux kernel,
18 run <make menuconfig>, configure the kernel as per the book and save
19 the resulting .config file. This suggestion also applies to the
20 configuration of the uClibc package when building a HLFS system using
21 uClibc rather than glibc.
22
232. PREREQUISITES::
24
25 To use this tool you MUST:
26
27 - have experience building {c,h,b}LFS packages
28 - know how to edit and write shell scripts
29 - know how a Makefile works
30 - be able to trace build failures and to find what is causing it
31 (user error, package bug, {c,h,b}LFS command bug, or jhalfs code bug)
32
33 If you do not have the above skills, please don't use this tool.
34
35
363. INSTALLATION::
37
38 No installation is required. System-wide installation is not allowed
39 for now.
40
414. CONFIGURATION FILES::
42
43 ::NEWS:: There is new configuration method for jhalfs.
44
45 We have installed the familiar menu based configuration tool driven by
46 by GNU make. see the section RUNNING, for details
47
485. RUNNING::
49
50 ::NEWS:: jhalfs is now launched via GNU make instead of individual symlinks.
51 The command <make> will launch a menu based configuration program. You will
52 recognize the layout from bulding the kernel or uClibc/Busybox. The
53 underlying menu code was borrowed from BusyBox and slightly modified for
54 our use.
55
56 Help on parameter function is available from the online help.
57
58 Once you have set the parameters you wish and have saved your work the
59 makefile will proceed to launch the jhalfs script. The script validate and
60 present you with your selections which you may accept or reject.
61
62 If you accepted the displayed settings jhalfs will proceed to create the
63 makefile, optionally download packages.
64
65 NOTE::
66 If you run the jhalfs script directly the only funcion you can select is to
67 display the version number
68
69
706. LAYOUT::
71
72 /CLFS/config
73 /master.sh
74 /xxxx.xsl
75
76 /CLFS2/config
77 /master.sh
78 /xxxx.xsl
79
80 /HLFS/config
81 /master.sh
82 /xxxx.xsl
83
84 /LFS/config
85 / master.sh
86 /xxxx.xsl
87
88 /common/config
89 /common_functions
90 /makefile_functions
91 /func_check_versions.sh
92 /func_validate_configs.sh
93
94 /contrib/jhalfs-paco.patch
95
96 /extras/do_copy_files
97 /do_ica_prep
98 /do_ica_work
99 /farce
100 /filelist
101
102 README
103 README.BLFS
104 README.PACO
105 TODO
106
107 Config.in
108 makefile
109 jhalfs
110 blfs-tool
111
1127. FAQ::
113 Q. "This 'help' file is very sparse"
114 A. Yes, it is. This tool, jhalfs, is for those who understand the LFS books
115 and wish to automate the build. 99% of any problems that arise can be
116 solved by reading the book(s).
117
118 Q. "It doesn't work!"
119 A. Yes it does, try >> make
120 Remember you must either be 'root' to run this script or have 'sudo' privileges.
121
122 Q. "It still doesn't work"
123 A. jhalfs was designed to work against the developement versions of the LFS
124 series of books. Consequently changes in a book(s) sometimes breaks older
125 versions of jhalfs. Before you start pulling out your hair download the
126 latest version of jhalfs to see if that solves your problem.
127
128 Q. "How do I specify the build location?"
129 A. The original LFS document worked against the well known location /mnt/lfs.
130 This script automates the build of all of the LFS series of books and uses
131 a generic location $BUILDDIR with a default value of /mnt/build_dir.
132 You may change this value to suit your needs.
133
134 The layout below $BUILDDIR is as follows.
135 $BUILDDIR/
136 jhalfs (makefile,cmd scripts,logs..etc)
137 sources (where packages reside)
138 tools (temporary bootstrap system)
139 cross-tools (temporary CLFS only)
140 ...
141 FHS dir structure
142 ...
143
144 Q. "What is the function of the SRC_ARCHIVE variable?"
145 A. When then symlinked master.sh runs it creates a local copy of the
146 necessary packages in BUILDDIR/sources by downloading the files. If
147 the variable SRC_ARCHIVE is defined the software will first look in
148 this location for the file and, if found, will copy it to BUILDDIR/sources.
149 If the files are not found in SRC_ARCHIVE _and_ you have write priv to
150 the directory any downloaded files will be mirrored there.
151
152 Q. "How do I set the SRC_ARCHIVE location?"
153 A. The best way to set the value of SRC_ARCHIVE is
154 export SRC_ARCHIVE=/wherever/you/store/downloaded/packages
155 OR
156 you can change the setting in common/config.
157
158 Q. "Why have 2 copies of the files?"
159 A. The package files must be visible during the chroot phase and this is a
160 simple and reliable method of doing so. This method also handles the CLFS
161 build method where the final build may be done on a separate machine.
162
163 Q. "What is the function of LUSER and LGROUP? There is no cmd line switch"
164 A. If you are running jhalfs from a low or non-priveledged account you may not
165 have the priv to create/delete accounts. These variables are adjustable
166 when invoking make.
167 $BUILDDIR make LUSER=myaccount LGROUP=mygroup
168 Then only changes to your account will be the creation of a NEW .bashrc after
169 saving your original to .bashrc.XXX
170
171 Q. "When I try to build 'xxx' with clfs the makefile fails at the mid-point"
172 A. There could be numerous reasons for the failure but the most likely reason
173 is you are doing a cross-build using the 'chroot' method and the target is
174 not compatible with the host. If you choose to build using the chroot
175 method a test is performed at the end of the temptools phase. If the test
176 succeeds the build continues inside a chroot jail. However if the test fails
177 it means the host and target are not compatible an you should use the
178 'boot' method to create your target code.
179 As an extreme example: You can build a sparc target on a x86 platform but
180 only the temptools phase. You must select the 'boot' method and not the
181 'chroot.' You must transfer the toolchain to a sparc platform, reboot the
182 sparc box and continue the build.
183 Of all the LFS series of books Cross-LFS requires the greatest
184 understanding of host/target hardware combination. Please read the book
185 carefully and don't skip the easy parts (there are none..)
186
187Authors:
188 George Boudreau
189 Manuel Canales Esparcia
190 Jeremy Huntwork
Note: See TracBrowser for help on using the repository browser.