source: README@ ddde18e

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

Work on README.. more to come

  • Property mode set to 100644
File size: 5.8 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
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.
[73e5448]36
[d3b8635]37 The term <symlink> refers to the 1 of 3 package symlinks, lfs,hlfs,clfs.
[877cc6a]38 Replace <symlink> with your choice of packages; i.e.: ./lfs
39
[b240ee6]40 ./<symlink> eg: ./lfs or ./hlfs
[877cc6a]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
[b240ee6]44 ./<symlink> -G eg: ./lfs -G
[877cc6a]45 Download the packages and patches necessary to build <symlink>
46
[b240ee6]47 ./<symlink> -G -M eg: ./lfs -G -M
[877cc6a]48 Download the packages, create and automatically run the Makefile
49
[b240ee6]50 ./<symlink> --help eg: ./lfs --help
51 will give you a context sensitive list of command line switches.
[877cc6a]52
[ddde18e]53 >>>> an expanded example
54
55 export SRC_ARCHIVE=/mnt/SourceFiles
56
57 ./lfs -D /mnt/partition4 \
58 -K ~/jhalfs_configs/linux-2.6.16.19-LFS.config \
59 -F ~/jhalfs-configs/fstab-sda3 \
60 -G -T 0 -M
61
62 explanation:::
63
64 export SRC_ARCHIVE=/mnt/SourceFiles
65 # This points to a local archive of existing packages. If the version in
66 the archive is incorrect jhalfs will access the net and download the
67 necessary version and store it here for later use. DO NOT set this to
68 $BUILDDIR/sources. If you do not set this variable to a valide directory
69 ALL package tarballs will be downloaded from the 'net.
70
71 -D /mnt/partition4
72 # where everything takes place. ..NOTE it must already exist and be mounted
73
74 -K ~/jhalfs_configs/linux-2.6.16.19-LFS.config
75 # If you want to automatically build a the kernel you MUST supply a valid
76 kernel configuration file. The file you supply will be copied and renamed.
77
78 -F ~/jhalfs-configs/fstab-sda3
79 # If you have a fstab file you wish to use it will be copied and renamed
80
81 -G # Retrieve the package files. You MUST enable this flag at least once if you
82 wish to do a build or whenever you update the book.
83
84 -T 0 # don't run any testsuites
85
86 -M # automatically run make against Makefile once jhalfs finishes its work.
87
88
[877cc6a]895. LAYOUT::
90
[b240ee6]91 /CLFS/config
92 /master.sh
93 /xxxx.xsl
[d3b8635]94
[b240ee6]95 /HLFS/config
96 /master.sh
97 /xxxx.xsl
98
99 /LFS/config
100 / master.sh
101 /xxxx.xsl
102
103 /common/config
104 /common_functions
105 /makefile_functions
106 /func_check_versions.sh
107 /func_validate_configs.sh
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 README
118 README.PACO
119 TODO
[d3b8635]120
[b240ee6]121 ./clfs ---|
[d3b8635]122 ./hlfs ---|+---> master.sh
123 ./lfs ---|
124
125
[877cc6a]1266. FAQ::
[e51d4db]127 Q. "It doesn't work!"
[b240ee6]128 A. Yes it does, try ./lfs --help
[d3b8635]129
[e51d4db]130 Q. "How do I specify the build location?"
[511923a]131 A. The original LFS document worked against the well know location /mnt/lfs.
132 This script automates the build of all of the LFS series of books and uses
[c5a416f]133 a generic location $BUILDDIR with a default value a /mnt/build_dir.
[511923a]134 You may change this value to suit your needs.
[d3b8635]135
[511923a]136 The layout below $BUILDDIR is as follows.
137 $BUILDDIR/
138 jhalfs (makefile,cmd scripts,logs..etc)
[b240ee6]139 sources (where packages reside)
[d3b8635]140 tools (temporary bootstrap system)
[b240ee6]141 cross-tools (temporary CLFS only)
[511923a]142 ...
143 FHS dir structure
144 ...
[d3b8635]145
[e51d4db]146 Q. "What is the function of the SRC_ARCHIVE variable?"
[f4b3d20]147 A. When then symlinked master.sh runs it creates a local copy of the
[73e5448]148 necessary packages in BUILDDIR/sources by downloading the files. If
149 the variable SRC_ARCHIVE is defined the software will first look in
[f4b3d20]150 this location for the file and, if found, will copy it to BUILDDIR/sources.
[73e5448]151 If the files are not found in SRC_ARCHIVE _and_ you have write priv to
[f4b3d20]152 the directory any downloaded files will be mirrored there.
[d3b8635]153
[e51d4db]154 Q. "How do I set the SRC_ARCHIVE location?"
[511923a]155 A. The best way to set the value of SRC_ARCHIVE is
156 export SRC_ARCHIVE=/wherever/you/store/downloaded/packages
157 OR
[d3b8635]158 you can change the setting in .common/config.
159
[e51d4db]160 Q. "Why have 2 copies of the files?"
[73e5448]161 A. The package files must be visible during the chroot phase and this is a
[877cc6a]162 simple and reliable method of doing so. This method also handles the CLFS
163 build method where the final build may be done on a separate machine.
164
165Authors:
166 George Boudreau
167 Manuel Canales Esparcia
168 Jeremy Huntwork
Note: See TracBrowser for help on using the repository browser.