source: FUNCTION_LIST@ c1decbe

ablfs
Last change on this file since c1decbe was c1decbe, checked in by Pierre Labastie <pierre@…>, 13 years ago

Correct typos in FUNCTION_LIST

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