source: README@ 0755d1a

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

README grammar change

  • Property mode set to 100644
File size: 4.5 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 kernal 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>
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
45 Download the packages and patches necessary to build <symlink>
46
47 ./<symlink> -G -M
48 Download the packages, create and automatically run the Makefile
49
50 ./<symlink> --help will give you a context sensitive list of command
51 line switches.
52
535. LAYOUT::
54
55 blfs --+ /BLFS config ---+ /common/config
56 | master.sh -+ /common_functions
57 | xxxx.xsl -+ /makefile_functions
58 | /func_check_versions.sh
59 clfs --+ /CLFS config ---+ /func_validate_configs.sh
60 | master.sh -+
61 | xxxx.xsl -+
62 |
63 +--------------------- master.sh --------------->>>
64 +--README
65 |
66 hlfs --+ /HLFS config ---+
67 | master.sh -+
68 | xxxx.xsl -+
69 |
70 lfs --+ /LFS config ---+
71 master.sh -+
72 xxxx.xsl -+
73
74
756. FAQ::
76 Q. "It doesn't work"
77 A. Yes it does..
78
79 Q. "How do I specify the build location"
80 A. The original LFS document worked against the well know location /mnt/lfs.
81 This script automates the build of all of the LFS series of books and uses
82 a generic location $BUILDDIR with a default value a /mnt/build_dir.
83 You may change this value to suit your needs.
84
85 The layout below $BUILDDIR is as follows.
86 $BUILDDIR/
87 jhalfs (makefile,cmd scripts,logs..etc)
88 sources (where packages reside
89 temptools (temporary bootstrap system
90 cross-tools (CLFS only)
91 ...
92 FHS dir structure
93 ...
94
95 Q. "What is the function of the SRC_ARCHIVE variable
96 A. When then symlinked master.sh runs it creates a local copy of the
97 necessary packages in BUILDDIR/sources by downloading the files. If
98 the variable SRC_ARCHIVE is defined the software will first look in
99 this location for the file and, if found, will copy it to BUILDDIR/sources.
100 If the files are not found in SRC_ARCHIVE _and_ you have write priv to
101 the directory any downloaded files will be mirrored there.
102
103 Q. "How do I set the SRC_ARCHIVE location"
104 A. The best way to set the value of SRC_ARCHIVE is
105 export SRC_ARCHIVE=/wherever/you/store/downloaded/packages
106 OR
107 you can change the setting in .common/config.
108
109 Q. "Why have 2 copies of the files."
110 A. The package files must be visible during the chroot phase and this is a
111 simple and reliable method of doing so. This method also handles the CLFS
112 build method where the final build may be done on a separate machine.
113
114Authors:
115 George Boudreau
116 Manuel Canales Esparcia
117 Jeremy Huntwork
Note: See TracBrowser for help on using the repository browser.