1 | $Id$
|
---|
2 |
|
---|
3 | This is the list of functions used in jhalfs, excluding BLFS tool functions
|
---|
4 | and functions defined in {C,H}LFS/master.sh.
|
---|
5 | I felt the need for documenting it when trying to add package management.
|
---|
6 | Functions are listed in alphabetical order, with a short description and the
|
---|
7 | file where they are defined.
|
---|
8 |
|
---|
9 | --------------------------------------------------------------------------
|
---|
10 | install_blfs_tools():
|
---|
11 | From common/libs/func_install_blfs.
|
---|
12 | Description: Copy the needed files to `BLFS_ROOT'. Initialize
|
---|
13 | the package tracking. Generates a `configuration' file from
|
---|
14 | the tool dependencies settings, and use it to generate
|
---|
15 | scriptlets from the blfs book. Uses those scriptlets to download the
|
---|
16 | needed tarballs. Then generates a Makefile for building the dependencies.
|
---|
17 | Called by: jhalfs
|
---|
18 | --------------------------------------------------------------------------
|
---|
19 | get_sources():
|
---|
20 | From common/libs/func_download_pkgs.
|
---|
21 | Description: Downloads packages if `GETPKG' is `y'. Writes package name
|
---|
22 | and md5 checksum to `MISSING_FILES.DMP' if a package cannot be found in
|
---|
23 | `$SRC_ARCHIVE' and cannot be downloaded, or if md5 checksum does not agree
|
---|
24 | book's one. If `MISSING_FILES.DMP' is not empty at the end of the process,
|
---|
25 | disable the excution of the makefile.
|
---|
26 | Actually, if `$BUILDDIR/sources' does not exist, it is not created if
|
---|
27 | `GETPKG' is `n'. And an empty or non existent `$BUILDDIR/sources' is
|
---|
28 | not flagged...
|
---|
29 | If `GETPKG' is `y', removes `MD5SUMS', `MISSING_FILES.DMP', and `urls.lst'
|
---|
30 | from `$BUILDDIR/sources' and generates them in the course of the process.
|
---|
31 | Called by: get_book and extract_commands
|
---|
32 | --------------------------------------------------------------------------
|
---|
33 | gs_wrt_message():
|
---|
34 | From common/libs/func_download_pkgs.
|
---|
35 | Description: internal function in get_sources. Writes a message to the screen
|
---|
36 | and a package name to `MISSING_FILES.DMP'.
|
---|
37 | --------------------------------------------------------------------------
|
---|
38 | create_urls():
|
---|
39 | From common/libs/func_download_pkgs.
|
---|
40 | Description: Runs xsltproc with stylesheet urls.xsl on chapter 3 of the
|
---|
41 | book. Add BLFS dependencies and custom dependencies if `BLFS_TOOLS' is `y'
|
---|
42 | and `CUSTOM_TOOLS' is `y' respectively.
|
---|
43 | Called by: get_sources
|
---|
44 | --------------------------------------------------------------------------
|
---|
45 | wrt_CustomTools_target():
|
---|
46 | From common/libs/func_custom_pkgs.
|
---|
47 | Description: Add users supplied scripts to `$JHALFSDIR/custom-tools', with
|
---|
48 | corresponding entry in the Makefile.
|
---|
49 | TODO: Add package management (instructions to user and Makefile entry)
|
---|
50 | Called by: All master.sh `build_Makefile'.
|
---|
51 | --------------------------------------------------------------------------
|
---|
52 | add_CustomToolsURLS():
|
---|
53 | From common/libs/func_custom_pkgs.
|
---|
54 | Description: Add any users supplied scripts URL information to urls.lst
|
---|
55 | Called by: create_urls
|
---|
56 | --------------------------------------------------------------------------
|
---|
57 | wrt_Makefile_header():
|
---|
58 | From common/libs/func_wrt_Makefile.
|
---|
59 | Description: Writes the beginning of the Makefile into $MKFILE, which created
|
---|
60 | or erased before.
|
---|
61 | Called by: All master.sh `build_Makefile'.
|
---|
62 | --------------------------------------------------------------------------
|
---|
63 | get_package_tarball_name():
|
---|
64 | From common/libs/func_wrt_Makefile.
|
---|
65 | Arguments: $1 contains the script_name
|
---|
66 | Description: Retrieves the tarball name from `pkg_tarball_list' by comparing
|
---|
67 | script-name to the beginning of a line in the list. Writes the name found
|
---|
68 | to stdout.
|
---|
69 | Implements the behavior described in README.CUSTOM, that is, if script_name
|
---|
70 | begins with d-, strip that part.
|
---|
71 | Called by: various functions in master.sh
|
---|
72 | --------------------------------------------------------------------------
|
---|
73 | LUSER_wrt_target():
|
---|
74 | From common/libs/func_wrt_Makefile.
|
---|
75 | Arguments: $1 contains target name; $2 contains dependency(ies)
|
---|
76 | Description: Add lines in the Makefile, which create target and
|
---|
77 | initialize log file.
|
---|
78 | LUSER version uses $MOUNT_PT in absolute path names.
|
---|
79 | Called by: chapter5_Makefiles and chapter6_Makefiles in LFS/master.sh
|
---|
80 | and other master.sh
|
---|
81 | --------------------------------------------------------------------------
|
---|
82 | CHROOT_wrt_target():
|
---|
83 | From common/libs/func_wrt_Makefile.
|
---|
84 | Arguments: $1 contains target name; $2 contains dependency(ies)
|
---|
85 | Description: Add lines in the Makefile, which create target and
|
---|
86 | initialize log file.
|
---|
87 | CHROOT version uses / in absolute path names.
|
---|
88 | Called by: chapter6_Makefiles and chapter78_Makefiles in LFS/master.sh
|
---|
89 | and other functions in other master.sh
|
---|
90 | --------------------------------------------------------------------------
|
---|
91 | LUSER_wrt_unpack():
|
---|
92 | From common/libs/func_wrt_Makefile.
|
---|
93 | Arguments: $1 contains tarball name; $2 contains 1 if the existing directory
|
---|
94 | is to be presserved.
|
---|
95 | Description: Add lines in the Makefile, which unpack and set 'ROOT' var and
|
---|
96 | remove existing dir if $2 != 1
|
---|
97 | LUSER version uses $MOUNT_PT in absolute path names.
|
---|
98 | Uses: Makefile functions remove_existing_dirs, unpack, get_pkg_root.
|
---|
99 | --------------------------------------------------------------------------
|
---|
100 | CHROOT_Unpack():
|
---|
101 | From common/libs/func_wrt_Makefile.
|
---|
102 | Arguments: $1 contains tarball name; $2 contains 1 if the existing directory
|
---|
103 | is to be presserved.
|
---|
104 | Description: Add lines in the Makefile, which unpack and set 'ROOT' var and
|
---|
105 | remove existing dir if $2 != 1
|
---|
106 | CHROOT version uses / in absolute path names.
|
---|
107 | Uses: Makefile functions remove_existing_dirs2, unpack2, get_pkg_root2.
|
---|
108 | --------------------------------------------------------------------------
|
---|
109 | LUSER_wrt_test_log():
|
---|
110 | From common/libs/func_wrt_Makefile.
|
---|
111 | Description: Add lines in the Makefile, which initialize testsuite
|
---|
112 | log file.
|
---|
113 | LUSER version uses $MOUNT_PT in absolute path names.
|
---|
114 | --------------------------------------------------------------------------
|
---|
115 | CHROOT_wrt_test_log():
|
---|
116 | From common/libs/func_wrt_Makefile.
|
---|
117 | Description: Add lines in the Makefile, which initialize testsuite
|
---|
118 | log file.
|
---|
119 | CHROOT version uses / in absolute path names.
|
---|
120 | --------------------------------------------------------------------------
|
---|
121 | wrt_RunAsRoot():
|
---|
122 | From common/libs/func_wrt_Makefile.
|
---|
123 | Description: Some scripts must be run as root..
|
---|
124 | --------------------------------------------------------------------------
|
---|
125 | LUSER_wrt_RunAsUser():
|
---|
126 | From common/libs/func_wrt_Makefile.
|
---|
127 | Description: Calculate time with perl, footer to log file
|
---|
128 | --------------------------------------------------------------------------
|
---|
129 | CHROOT_wrt_RunAsRoot():
|
---|
130 | From common/libs/func_wrt_Makefile.
|
---|
131 | Description:
|
---|
132 | --------------------------------------------------------------------------
|
---|
133 | LUSER_wrt_CopyFstab():
|
---|
134 | From common/libs/func_wrt_Makefile.
|
---|
135 | Description:
|
---|
136 | --------------------------------------------------------------------------
|
---|
137 | CHROOT_wrt_CopyFstab():
|
---|
138 | From common/libs/func_wrt_Makefile.
|
---|
139 | Description:
|
---|
140 | --------------------------------------------------------------------------
|
---|
141 | LUSER_wrt_TouchTimestamp():
|
---|
142 | From common/libs/func_wrt_Makefile.
|
---|
143 | Description:
|
---|
144 | --------------------------------------------------------------------------
|
---|
145 | CHROOT_wrt_TouchTimestamp():
|
---|
146 | From common/libs/func_wrt_Makefile.
|
---|
147 | Description:
|
---|
148 | --------------------------------------------------------------------------
|
---|
149 | LUSER_wrt_LogNewFiles():
|
---|
150 | From common/libs/func_wrt_Makefile.
|
---|
151 | Description:
|
---|
152 | --------------------------------------------------------------------------
|
---|
153 | CHROOT_wrt_LogNewFiles():
|
---|
154 | From common/libs/func_wrt_Makefile.
|
---|
155 | Description:
|
---|
156 | --------------------------------------------------------------------------
|
---|
157 | LUSER_RemoveBuildDirs():
|
---|
158 | From common/libs/func_wrt_Makefile.
|
---|
159 | Description:
|
---|
160 | --------------------------------------------------------------------------
|
---|
161 | CHROOT_wrt_RemoveBuildDirs():
|
---|
162 | From common/libs/func_wrt_Makefile.
|
---|
163 | Description:
|
---|
164 | --------------------------------------------------------------------------
|
---|
165 | wrt_touch():
|
---|
166 | From common/libs/func_wrt_Makefile.
|
---|
167 | Description:
|
---|
168 | --------------------------------------------------------------------------
|
---|
169 | wrt_compare_targets():
|
---|
170 | From common/libs/func_compare.sh.
|
---|
171 | Description:
|
---|
172 | --------------------------------------------------------------------------
|
---|
173 | wrt_system_build():
|
---|
174 | From common/libs/func_compare.sh.
|
---|
175 | Description:
|
---|
176 | --------------------------------------------------------------------------
|
---|
177 | wrt_compare_work():
|
---|
178 | From common/libs/func_compare.sh.
|
---|
179 | Description:
|
---|
180 | --------------------------------------------------------------------------
|
---|
181 | wrt_do_ica_work():
|
---|
182 | From common/libs/func_compare.sh.
|
---|
183 | Description:
|
---|
184 | --------------------------------------------------------------------------
|
---|
185 | wrt_logs():
|
---|
186 | From common/libs/func_compare.sh.
|
---|
187 | Description:
|
---|
188 | --------------------------------------------------------------------------
|
---|
189 | validate_config():
|
---|
190 | From common/libs/func_validate_configs.sh.
|
---|
191 | Description: Are the config values sane (within reason)
|
---|
192 | --------------------------------------------------------------------------
|
---|
193 | write_error_and_die():
|
---|
194 | From common/libs/func_validate_configs.sh.
|
---|
195 | Description:
|
---|
196 | --------------------------------------------------------------------------
|
---|
197 | validate_file():
|
---|
198 | From common/libs/func_validate_configs.sh.
|
---|
199 | Description:
|
---|
200 | --------------------------------------------------------------------------
|
---|
201 | validate_dir():
|
---|
202 | From common/libs/func_validate_configs.sh.
|
---|
203 | Description:
|
---|
204 | --------------------------------------------------------------------------
|
---|
205 | get_book():
|
---|
206 | From common/libs/func_book_parser.
|
---|
207 | Description:
|
---|
208 | --------------------------------------------------------------------------
|
---|
209 | extract_commands():
|
---|
210 | From common/libs/func_book_parser.
|
---|
211 | Description:
|
---|
212 | --------------------------------------------------------------------------
|
---|
213 | create_package_list():
|
---|
214 | From common/libs/func_book_parser.
|
---|
215 | Description:
|
---|
216 | --------------------------------------------------------------------------
|
---|
217 | check_version():
|
---|
218 | From common/libs/func_check_version.sh.
|
---|
219 | Description:
|
---|
220 | --------------------------------------------------------------------------
|
---|
221 | write_error_and_die():
|
---|
222 | From common/libs/func_check_version.sh.
|
---|
223 | Description:
|
---|
224 | --------------------------------------------------------------------------
|
---|
225 | check_prerequisites():
|
---|
226 | From common/libs/func_check_version.sh.
|
---|
227 | Description:
|
---|
228 | --------------------------------------------------------------------------
|
---|
229 | write_or_exit():
|
---|
230 | From common/progress_bar.sh.
|
---|
231 | Description:
|
---|
232 | --------------------------------------------------------------------------
|
---|
233 | no_empty_builddir():
|
---|
234 | From common/common-functions.
|
---|
235 | Description:
|
---|
236 | --------------------------------------------------------------------------
|
---|
237 | run_make():
|
---|
238 | From common/common-functions.
|
---|
239 | Description:
|
---|
240 | --------------------------------------------------------------------------
|
---|
241 | clean_builddir():
|
---|
242 | From common/common-functions.
|
---|
243 | Description:
|
---|
244 | --------------------------------------------------------------------------
|
---|
245 | process_toolchain():
|
---|
246 | From HLFS/master.sh.
|
---|
247 | Description: embryo,cocoon and butterfly need special handling
|
---|
248 | --------------------------------------------------------------------------
|
---|
249 | chapter3_Makefiles():
|
---|
250 | From HLFS/master.sh.
|
---|
251 | Description: Initialization of the system
|
---|
252 | --------------------------------------------------------------------------
|
---|
253 | chapter5_Makefiles():
|
---|
254 | From HLFS/master.sh.
|
---|
255 | Description: Bootstrap or temptools phase
|
---|
256 | --------------------------------------------------------------------------
|
---|
257 | chapter6_Makefiles():
|
---|
258 | From HLFS/master.sh.
|
---|
259 | Description: sysroot or chroot build phase
|
---|
260 | --------------------------------------------------------------------------
|
---|
261 | chapter7_Makefiles():
|
---|
262 | From HLFS/master.sh.
|
---|
263 | Description: Create a bootable system.. kernel, bootscripts..etc
|
---|
264 | --------------------------------------------------------------------------
|
---|
265 | build_Makefile():
|
---|
266 | From HLFS/master.sh.
|
---|
267 | Description: Construct a Makefile from the book scripts
|
---|
268 | --------------------------------------------------------------------------
|
---|
269 | simple_error():
|
---|
270 | From jhalfs.
|
---|
271 | Description: Basic error trap.... JUST DIE
|
---|
272 | --------------------------------------------------------------------------
|
---|
273 | see_ya():
|
---|
274 | From jhalfs.
|
---|
275 | Description:
|
---|
276 | --------------------------------------------------------------------------
|
---|
277 | chapter4_Makefiles():
|
---|
278 | From LFS/master.sh.
|
---|
279 | Description:
|
---|
280 | --------------------------------------------------------------------------
|
---|
281 | chapter5_Makefiles():
|
---|
282 | From LFS/master.sh.
|
---|
283 | Description:
|
---|
284 | --------------------------------------------------------------------------
|
---|
285 | chapter6_Makefiles():
|
---|
286 | From LFS/master.sh.
|
---|
287 | Description:
|
---|
288 | --------------------------------------------------------------------------
|
---|
289 | chapter78_Makefiles():
|
---|
290 | From LFS/master.sh.
|
---|
291 | Description:
|
---|
292 | --------------------------------------------------------------------------
|
---|
293 | build_Makefile():
|
---|
294 | From LFS/master.sh.
|
---|
295 | Description:
|
---|
296 | --------------------------------------------------------------------------
|
---|
297 | validate_opt_settings():
|
---|
298 | From optimize/optimize_functions.
|
---|
299 | Description: Show optimize setting and wait user agreement
|
---|
300 | --------------------------------------------------------------------------
|
---|
301 | wrt_optimize():
|
---|
302 | From optimize/optimize_functions.
|
---|
303 | Description: Apply pkg specific opt's to build
|
---|
304 | --------------------------------------------------------------------------
|
---|
305 | wrt_makeflags():
|
---|
306 | From optimize/optimize_functions.
|
---|
307 | Description: Apply MAKEFLAGS to build
|
---|
308 | --------------------------------------------------------------------------
|
---|