source: FUNCTION_LIST@ 6f74ca1

ablfs-more legacy trunk
Last change on this file since 6f74ca1 was f596dde, checked in by Pierre Labastie <pierre@…>, 6 years ago

Get rid of the GPLv2 license:

  • Replace the menu system with the Kconfiglib, which has an ISC license
  • Remove farce and any reference to it
  • Rewrite the copyright notice, add the LICENSE files
  • Adapt Config.in and a few other programs to the new menu system
  • Property mode set to 100644
File size: 12.7 KB
RevLine 
[4c6f54f]1$Id$
[7072e1f]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--------------------------------------------------------------------------
[e576789]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
[7072e1f]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'
[2e1c1c3]42and `CUSTOM_TOOLS' is `y' respectively.
[7072e1f]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.
[2e1c1c3]71Called by: various functions in master.sh
[7072e1f]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.
[2e1c1c3]131Description:
[7072e1f]132--------------------------------------------------------------------------
133LUSER_wrt_CopyFstab():
134From common/libs/func_wrt_Makefile.
[2e1c1c3]135Description:
[7072e1f]136--------------------------------------------------------------------------
137CHROOT_wrt_CopyFstab():
138From common/libs/func_wrt_Makefile.
[2e1c1c3]139Description:
[7072e1f]140--------------------------------------------------------------------------
141LUSER_wrt_TouchTimestamp():
142From common/libs/func_wrt_Makefile.
[2e1c1c3]143Description:
[7072e1f]144--------------------------------------------------------------------------
145CHROOT_wrt_TouchTimestamp():
146From common/libs/func_wrt_Makefile.
[2e1c1c3]147Description:
[7072e1f]148--------------------------------------------------------------------------
149LUSER_wrt_LogNewFiles():
150From common/libs/func_wrt_Makefile.
[2e1c1c3]151Description:
[7072e1f]152--------------------------------------------------------------------------
153CHROOT_wrt_LogNewFiles():
154From common/libs/func_wrt_Makefile.
[2e1c1c3]155Description:
[7072e1f]156--------------------------------------------------------------------------
157LUSER_RemoveBuildDirs():
158From common/libs/func_wrt_Makefile.
[2e1c1c3]159Description:
[7072e1f]160--------------------------------------------------------------------------
161CHROOT_wrt_RemoveBuildDirs():
162From common/libs/func_wrt_Makefile.
[2e1c1c3]163Description:
[7072e1f]164--------------------------------------------------------------------------
165wrt_touch():
166From common/libs/func_wrt_Makefile.
[2e1c1c3]167Description:
[7072e1f]168--------------------------------------------------------------------------
169wrt_compare_targets():
170From common/libs/func_compare.sh.
[2e1c1c3]171Description:
[7072e1f]172--------------------------------------------------------------------------
173wrt_system_build():
174From common/libs/func_compare.sh.
[2e1c1c3]175Description:
[7072e1f]176--------------------------------------------------------------------------
177wrt_compare_work():
178From common/libs/func_compare.sh.
[2e1c1c3]179Description:
[7072e1f]180--------------------------------------------------------------------------
181wrt_do_ica_work():
182From common/libs/func_compare.sh.
[2e1c1c3]183Description:
[7072e1f]184--------------------------------------------------------------------------
185wrt_logs():
186From common/libs/func_compare.sh.
[2e1c1c3]187Description:
[7072e1f]188--------------------------------------------------------------------------
189validate_config():
190From common/libs/func_validate_configs.sh.
191Description: Are the config values sane (within reason)
192--------------------------------------------------------------------------
193 write_error_and_die():
194From common/libs/func_validate_configs.sh.
[2e1c1c3]195Description:
[7072e1f]196--------------------------------------------------------------------------
197 validate_file():
198From common/libs/func_validate_configs.sh.
[2e1c1c3]199Description:
[7072e1f]200--------------------------------------------------------------------------
201 validate_dir():
202From common/libs/func_validate_configs.sh.
[2e1c1c3]203Description:
[7072e1f]204--------------------------------------------------------------------------
205get_book():
206From common/libs/func_book_parser.
[2e1c1c3]207Description:
[7072e1f]208--------------------------------------------------------------------------
209extract_commands():
210From common/libs/func_book_parser.
[2e1c1c3]211Description:
[7072e1f]212--------------------------------------------------------------------------
213create_package_list():
214From common/libs/func_book_parser.
[2e1c1c3]215Description:
[7072e1f]216--------------------------------------------------------------------------
217check_version():
218From common/libs/func_check_version.sh.
[2e1c1c3]219Description:
[7072e1f]220--------------------------------------------------------------------------
221 write_error_and_die():
222From common/libs/func_check_version.sh.
[2e1c1c3]223Description:
[7072e1f]224--------------------------------------------------------------------------
225check_prerequisites():
226From common/libs/func_check_version.sh.
[2e1c1c3]227Description:
[7072e1f]228--------------------------------------------------------------------------
229write_or_exit():
230From common/progress_bar.sh.
[2e1c1c3]231Description:
[7072e1f]232--------------------------------------------------------------------------
233no_empty_builddir():
234From common/common-functions.
[2e1c1c3]235Description:
[7072e1f]236--------------------------------------------------------------------------
237run_make():
238From common/common-functions.
[2e1c1c3]239Description:
[7072e1f]240--------------------------------------------------------------------------
241clean_builddir():
242From common/common-functions.
[2e1c1c3]243Description:
[7072e1f]244--------------------------------------------------------------------------
245process_toolchain():
246From HLFS/master.sh.
247Description: embryo,cocoon and butterfly need special handling
248--------------------------------------------------------------------------
249chapter3_Makefiles():
250From HLFS/master.sh.
251Description: Initialization of the system
252--------------------------------------------------------------------------
253chapter5_Makefiles():
254From HLFS/master.sh.
255Description: Bootstrap or temptools phase
256--------------------------------------------------------------------------
257chapter6_Makefiles():
258From HLFS/master.sh.
259Description: sysroot or chroot build phase
260--------------------------------------------------------------------------
261chapter7_Makefiles():
262From HLFS/master.sh.
263Description: Create a bootable system.. kernel, bootscripts..etc
264--------------------------------------------------------------------------
265build_Makefile():
266From HLFS/master.sh.
267Description: Construct a Makefile from the book scripts
268--------------------------------------------------------------------------
269simple_error():
270From jhalfs.
271Description: Basic error trap.... JUST DIE
272--------------------------------------------------------------------------
273see_ya():
274From jhalfs.
[2e1c1c3]275Description:
[7072e1f]276--------------------------------------------------------------------------
277chapter4_Makefiles():
278From LFS/master.sh.
[2e1c1c3]279Description:
[7072e1f]280--------------------------------------------------------------------------
281chapter5_Makefiles():
282From LFS/master.sh.
[2e1c1c3]283Description:
[7072e1f]284--------------------------------------------------------------------------
285chapter6_Makefiles():
286From LFS/master.sh.
[2e1c1c3]287Description:
[7072e1f]288--------------------------------------------------------------------------
289chapter78_Makefiles():
290From LFS/master.sh.
[2e1c1c3]291Description:
[7072e1f]292--------------------------------------------------------------------------
293build_Makefile():
294From LFS/master.sh.
[2e1c1c3]295Description:
[7072e1f]296--------------------------------------------------------------------------
297validate_opt_settings():
298From optimize/optimize_functions.
299Description: Show optimize setting and wait user agreement
300--------------------------------------------------------------------------
301wrt_optimize():
302From optimize/optimize_functions.
303Description: Apply pkg specific opt's to build
304--------------------------------------------------------------------------
305wrt_makeflags():
306From optimize/optimize_functions.
307Description: Apply MAKEFLAGS to build
308--------------------------------------------------------------------------
Note: See TracBrowser for help on using the repository browser.