| 1 | $Id$
|
|---|
| 2 |
|
|---|
| 3 | 1. INTRODUCTION::
|
|---|
| 4 |
|
|---|
| 5 | To automatize packages build from the BLFS book instructions is a huge
|
|---|
| 6 | task. The BLFS book isn't linear, some package pages need to use a non
|
|---|
| 7 | default layout, there are circular dependencies, several packages can be
|
|---|
| 8 | installed on a non default prefix, build commands can change based on what
|
|---|
| 9 | dependencies will be used, etc.
|
|---|
| 10 |
|
|---|
| 11 | Said that, the goal of jhalfs is try to help you solving packages
|
|---|
| 12 | dependencies and creating your own build scripts/Makefile. Some of the
|
|---|
| 13 | auto-generated build scripts and Makefile could work "as is", but as a
|
|---|
| 14 | general rule you will need to review and edit the scripts while reading
|
|---|
| 15 | the book.
|
|---|
| 16 |
|
|---|
| 17 | NOTE:: The code is still under development and may contains several bugs
|
|---|
| 18 |
|
|---|
| 19 |
|
|---|
| 20 | 2. USAGE::
|
|---|
| 21 |
|
|---|
| 22 | Due the complexity of the BLFS book, the scripts/Makefile generation is
|
|---|
| 23 | done in several steps:
|
|---|
| 24 |
|
|---|
| 25 | 2.1 INSTALLATION::
|
|---|
| 26 |
|
|---|
| 27 | Run "make" to launch the jhalfs menuconfig interface. Select the BLFS
|
|---|
| 28 | book and it version. Then set the installation directory (default
|
|---|
| 29 | $HOME/blfs_root) and the BLFS sources directory (default blfs-xml).
|
|---|
| 30 |
|
|---|
| 31 | All required files will be placed in the installation directory and
|
|---|
| 32 | BLFS XML sources will be checkout to the named sub-directory.
|
|---|
| 33 |
|
|---|
| 34 | Installed files:
|
|---|
| 35 |
|
|---|
| 36 | blfs-xml/* SVN tree of the selected BLFS book version
|
|---|
| 37 | lib/* functions libraries, xsl stylesheets, and auto-generated
|
|---|
| 38 | meta-packages dependencies tree files
|
|---|
| 39 | menu/* lxdialog and menuconfig source code
|
|---|
| 40 | README.BLFS this file
|
|---|
| 41 | TODO developers notes
|
|---|
| 42 | update_book.sh update the XML book sources and regenerates packages
|
|---|
| 43 | database and meta-packages dependencies tree
|
|---|
| 44 | gen_config.sh regenerates Config.in
|
|---|
| 45 | blfs-parser.sh solve dependencies and generates linear BLFS books
|
|---|
| 46 | and build scripts
|
|---|
| 47 | gen-makefile.sh generates target Makefile
|
|---|
| 48 | progress_bar.sh the target Makefile progress bar
|
|---|
| 49 | Makefile (not created yet) run gen_config.sh to update Config.in,
|
|---|
| 50 | then launch the menuconfig interface, and lastly run
|
|---|
| 51 | blfs-parser.sh based on configuration settings
|
|---|
| 52 | Config.in menuconfig interface input file
|
|---|
| 53 | packages auto-generated packages database
|
|---|
| 54 | alternatives.conf (to be removed) configuration file for alternative packages
|
|---|
| 55 | envars.conf envars needed when running the target build scripts
|
|---|
| 56 |
|
|---|
| 57 | From now on, all the work must be done from inside the installation
|
|---|
| 58 | root directory.
|
|---|
| 59 |
|
|---|
| 60 | 2.2 UPDATING BOOK SOURCES::
|
|---|
| 61 |
|
|---|
| 62 | If using the development book version, and if you want to update already
|
|---|
| 63 | installed packages to the new version found in that book, you need to update
|
|---|
| 64 | the XML sources and packages database.
|
|---|
| 65 |
|
|---|
| 66 | To do that run "./update_book.sh"
|
|---|
| 67 |
|
|---|
| 68 | 2.3 CONFIGURING AND PARSING THE BOOK:: (to be rewritten when ready menuconfig)
|
|---|
| 69 |
|
|---|
| 70 | Next step is to create a book and build scripts in dependencies build order
|
|---|
| 71 | for a target package. A target package can be any of the ones listed in the
|
|---|
| 72 | packages file. That is done using the blfs-parser.sh script, but we are trying
|
|---|
| 73 | to make a menuconfig based system.
|
|---|
| 74 |
|
|---|
| 75 | The script need three arguments:
|
|---|
| 76 |
|
|---|
| 77 | package name as listed in packages file
|
|---|
| 78 | dependencies level 1 for required,
|
|---|
| 79 | 2 for required an recommended
|
|---|
| 80 | 3 for required, recommended, and optional
|
|---|
| 81 | sudo usage y if sudo will be used (you want build as a normal user)
|
|---|
| 82 | n if sudo isn't needed (you want build as root)
|
|---|
| 83 |
|
|---|
| 84 | For example:
|
|---|
| 85 |
|
|---|
| 86 | ./blfs-parser galeon 3 y
|
|---|
| 87 |
|
|---|
| 88 | will create a directory named "galeon". Inside that directory you find a
|
|---|
| 89 | directory named "HTML" that contains a galeon-based HTML book with all
|
|---|
| 90 | dependencies in build order and a "scripts" directory with build scripts
|
|---|
| 91 | that uses sudo for commands that need root privileges.
|
|---|
| 92 |
|
|---|
| 93 | There is also two other directories, dependencies and xincludes, that
|
|---|
| 94 | contains files generated while resolving dependencies trees.
|
|---|
| 95 |
|
|---|
| 96 | 2.4 EDITING BUILD SCRIPTS
|
|---|
| 97 |
|
|---|
| 98 | Now is the time to review the generated book and scripts, making in the
|
|---|
| 99 | scripts any changes required to fix generation bugs or to fit your needs.
|
|---|
| 100 |
|
|---|
| 101 | Scripts for additional packages (i.e., for non-BLFS packages) can be
|
|---|
| 102 | inserted in an easy way due how the scripts are named. For example, if you
|
|---|
| 103 | want to install the external dependency "bar" before "foo" package and the
|
|---|
| 104 | "foo" script is named "064-z-foo", you need to create a "064-y-bar" build
|
|---|
| 105 | script.
|
|---|
| 106 |
|
|---|
| 107 | Note that the packages tracking system isn't a packages management tool
|
|---|
| 108 | and know nothing about packages not in the BLFS book.
|
|---|
| 109 |
|
|---|
| 110 | 2.5 CREATING THE MAKEFILE
|
|---|
| 111 | When the build scripts are ready to be run, the Makefile can be
|
|---|
| 112 | created. Be sure that you cd into the "package" directory and run
|
|---|
| 113 |
|
|---|
| 114 | ../gen_makefile.sh
|
|---|
| 115 |
|
|---|
| 116 | Review the Makefile and if all look sane, start the build.
|
|---|
| 117 |
|
|---|
| 118 |
|
|---|
| 119 | (Text is needed about meta-packages, the installed packages tracking system
|
|---|
| 120 | and like)
|
|---|
| 121 |
|
|---|
| 122 | 3. GENERATED BUILD SCRIPTS ISSUES::
|
|---|
| 123 |
|
|---|
| 124 | In this section known issues with the generated build scripts are
|
|---|
| 125 | discussed. They are due build procedures and/or BLFS layout particularities
|
|---|
| 126 | than we can't handle. In several cases editing the build scripts is mandatory.
|
|---|
| 127 | You may need also to insert some build script created by you to resolve
|
|---|
| 128 | unhandled dependencies and/or to remove some script installing the affected
|
|---|
| 129 | package by hand.
|
|---|
| 130 |
|
|---|
| 131 | 3.1 BLFS BOOTSCRIPTS
|
|---|
| 132 |
|
|---|
| 133 | For now, bootscripts installation will fail. You will need to edit the
|
|---|
| 134 | scripts for packages that install bootscripts and fix their installation
|
|---|
| 135 | command. That could be fixed in the future, but not sure.
|
|---|
| 136 |
|
|---|
| 137 | 3.2 PACKAGES CONFIGURATION
|
|---|
| 138 |
|
|---|
| 139 | For that packages that have a "Configuration" section, you should to
|
|---|
| 140 | edit it build script to fit the configuration to your needs.
|
|---|
| 141 |
|
|---|
| 142 | 3.4 PDL and Perl modules.
|
|---|
| 143 |
|
|---|
| 144 | The generated scripts for that packages are plainly broken and can't
|
|---|
| 145 | be fixed. You must to replace it by your own ones or install that
|
|---|
| 146 | packages by hand.
|
|---|
| 147 |
|
|---|
| 148 | 3.4 GCC, JDK, Sane, and KDE-multimedia
|
|---|
| 149 |
|
|---|
| 150 | On the pages for that packages, the BLFS book actually have instructions
|
|---|
| 151 | to install two packages. You must to edit the scripts to fix it. We will
|
|---|
| 152 | try to fix some of them, but may not be possible.
|
|---|
| 153 |
|
|---|
| 154 | 3.5 XORG7
|
|---|
| 155 |
|
|---|
| 156 | The generated script for Xorg7 pseudo-packages don't have support for
|
|---|
| 157 | $SRC_ARCHIVE nor MD5 checking.
|
|---|
| 158 |
|
|---|
| 159 | If you has downloaded previously the packages, you must to edit the scripts
|
|---|
| 160 | to make it to use your local packages.
|
|---|
| 161 |
|
|---|
| 162 | 3.6 PATCHES
|
|---|
| 163 |
|
|---|
| 164 | By default all required patches will be downloaded from the NET.
|
|---|
| 165 |
|
|---|
| 166 | If you has downloaded previously the patches, you must to edit the scripts
|
|---|
| 167 | to make it to use your local patches.
|
|---|
| 168 |
|
|---|
| 169 | Also, be sure that all scripts have the commands to download/apply the
|
|---|
| 170 | required patches. Due book layout issues some patches may be missing.
|
|---|
| 171 |
|
|---|
| 172 | 3.7 ROOT COMMANDS
|
|---|
| 173 |
|
|---|
| 174 | If building as a normal user (the default setting) be sure that all
|
|---|
| 175 | commands that need root privileges are run using sudo.
|
|---|
| 176 |
|
|---|
| 177 | Due book layout issues some sudo command may be missing.
|
|---|
| 178 |
|
|---|
| 179 | 3.8 OTHERS
|
|---|
| 180 |
|
|---|
| 181 | May have other issues that we are not aware on them yet. If you find
|
|---|
| 182 | someone, please report it to <alfs-discuss@linuxfromscratch.org>.
|
|---|
| 183 |
|
|---|
| 184 |
|
|---|
