source: README@ 4bc3c2b

1.0 2.3 2.3.x 2.4 ablfs ablfs-more legacy new_features trunk
Last change on this file since 4bc3c2b was e51d4db, checked in by Jeremy Huntwork <jhuntwork@…>, 19 years ago

Minor text corrections in the README

  • Property mode set to 100644
File size: 4.6 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. 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
324. RUNNING::
33 The script master.sh cannot be invoked directly but only via the
34 supplied symlinks. After editing the config file for the project you wish
35 to build, run the script.
36
37 The term <symlink> refers to the 1 of 4 package symlinks, lfs,hlfs,clfs,blfs.
38 Replace <symlink> with your choice of packages; i.e.: ./lfs
39
40 ./<symlink> eg: ./lfs or ./hlfs
41 Create a makefile based on the settings found in the config files.
42 You must enter the build partition/jhalfs directory and manually run <make>
43
44 ./<symlink> -G eg: ./lfs -G
45 Download the packages and patches necessary to build <symlink>
46
47 ./<symlink> -G -M eg: ./lfs -G -M
48 Download the packages, create and automatically run the Makefile
49
50 ./<symlink> --help eg: ./lfs --help
51 will give you a context sensitive list of command line switches.
52
535. LAYOUT::
54
55 /BLFS/config
56 /master.sh
57 /xxxx.xsl
58
59 /CLFS/config
60 /master.sh
61 /xxxx.xsl
62
63 /HLFS/config
64 /master.sh
65 /xxxx.xsl
66
67 /LFS/config
68 / master.sh
69 /xxxx.xsl
70
71 /common/config
72 /common_functions
73 /makefile_functions
74 /func_check_versions.sh
75 /func_validate_configs.sh
76
77 /contrib/jhalfs-paco.patch
78
79 /extras/do_copy_files
80 /do_ica_prep
81 /do_ica_work
82 /farce
83 /filelist
84
85 README
86 README.PACO
87 TODO
88
89 ./blfs ---+
90 ./clfs ---|
91 +---> master.sh
92 ./hlfs ---|
93 ./lfs ---+
94
95
966. FAQ::
97 Q. "It doesn't work!"
98 A. Yes it does, try ./lfs --help
99
100 Q. "How do I specify the build location?"
101 A. The original LFS document worked against the well know location /mnt/lfs.
102 This script automates the build of all of the LFS series of books and uses
103 a generic location $BUILDDIR with a default value a /mnt/build_dir.
104 You may change this value to suit your needs.
105
106 The layout below $BUILDDIR is as follows.
107 $BUILDDIR/
108 jhalfs (makefile,cmd scripts,logs..etc)
109 sources (where packages reside)
110 temptools (temporary bootstrap system)
111 cross-tools (temporary CLFS only)
112 ...
113 FHS dir structure
114 ...
115
116 Q. "What is the function of the SRC_ARCHIVE variable?"
117 A. When then symlinked master.sh runs it creates a local copy of the
118 necessary packages in BUILDDIR/sources by downloading the files. If
119 the variable SRC_ARCHIVE is defined the software will first look in
120 this location for the file and, if found, will copy it to BUILDDIR/sources.
121 If the files are not found in SRC_ARCHIVE _and_ you have write priv to
122 the directory any downloaded files will be mirrored there.
123
124 Q. "How do I set the SRC_ARCHIVE location?"
125 A. The best way to set the value of SRC_ARCHIVE is
126 export SRC_ARCHIVE=/wherever/you/store/downloaded/packages
127 OR
128 you can change the setting in .common/config.
129
130 Q. "Why have 2 copies of the files?"
131 A. The package files must be visible during the chroot phase and this is a
132 simple and reliable method of doing so. This method also handles the CLFS
133 build method where the final build may be done on a separate machine.
134
135Authors:
136 George Boudreau
137 Manuel Canales Esparcia
138 Jeremy Huntwork
Note: See TracBrowser for help on using the repository browser.