source: README@ d44206f

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

Update README to reflect new configuration format

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