source: FUNCTION_LIST@ 34986b8

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

Fix svn properties on some files

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