source: FUNCTION_LIST@ 4ccb5d7

legacy
Last change on this file since 4ccb5d7 was fd4a798, checked in by Pierre Labastie <pierre.labastie@…>, 3 years ago

Remove $Id$ comments, they are useless with git

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