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