zeroday0619/MahiroOS-jhalfs
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

1st pass at documentation housekeeping

Browse source
This commit is contained in:
George Boudreau 2007-07-05 18:37:13 +00:00
parent f600e66e52
commit 392bd252ba
2 changed files with 86 additions and 92 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README
View file

@ -46,17 +46,11 @@ $Id$
4. CONFIGURATION:: 4. CONFIGURATION::
::NEWS::
There is a new configuration method for jhalfs.
We have installed the familiar menu based configuration tool driven by We have installed the familiar menu based configuration tool driven by
GNU make. see the section RUNNING, for details GNU make. see the section RUNNING, for details
5. RUNNING:: 5. RUNNING::
::NEWS::
jhalfs is now launched via GNU make instead of individual symlinks.
The command <make> will launch a menu based configuration program. You will The command <make> will launch a menu based configuration program. You will
recognize the layout from building the kernel or uClibc/BusyBox. The recognize the layout from building the kernel or uClibc/BusyBox. The
underlying menu code was borrowed from BusyBox and slightly modified for underlying menu code was borrowed from BusyBox and slightly modified for

172
README.BLFS
View file

@ -2,22 +2,21 @@ $Id$
1. INTRODUCTION:: 1. INTRODUCTION::
To automatize packages build from the BLFS book instructions is a huge To automate package builds from the BLFS book instructions is a huge
task. The BLFS book isn't linear, some package pages need to use a non task. Some of the issues are: the BLFS book isn't linear; some package
default layout, there are circular dependencies, several packages can be pages use a custom layout; there are circular dependencies; several
installed on a non default prefix, build commands can change based on what packages can be installed on a non-default prefix; build commands can
dependencies will be used, etc. change based on what dependencies will be used, etc.
Said that, the goal of blfs-tool is try to help you solving packages That being said, the goal of the blfs-tool is to help you solve package
dependencies and creating your own build scripts and Makefile. Few of the dependencies, create build scripts and a Makefile. Few of the auto-generated
auto-generated build scripts and Makefile could work "as is", thus as a build scripts and Makefile will work "as is", thus, as a general rule,
general rule you will need to review and edit the scripts while reading you will need to review and edit the scripts while reading the book.
the book.
2. PREREQUISITES:: 2. PREREQUISITES::
To use this tool you MUST to: To use this tool you MUST:
- have experience building BLFS packages - have experience building BLFS packages
- know how to edit and write shell scripts - know how to edit and write shell scripts
@ -30,20 +29,21 @@ $Id$
3. USAGE:: 3. USAGE::
Due the complexity of the BLFS book, the scripts and Makefile generation is Due the complexity of the BLFS book, the scripts and Makefile generation
done in several steps: is done in several steps:
3.1 INSTALLED PACKAGES TRACKING SYSTEM 3.1 INSTALLED PACKAGES TRACKING SYSTEM
This tool includes a very simple tracking system to know what packages This tool includes a very simple tracking system to log which packages
has been installed using the tool. It is used to skip installed packages have been installed using the tool. It is used to skip installed packages
from target selection menu and to know if an installed package has been updated from target selection menu and to test if an installed package has been
on the BLFS book. Don't rely on this feature as a packages management tool. updated in the BLFS book. Do not rely on this feature as a package
management tool.
The directory where tracking files will be stored need be created The directory where tracking files will be stored needs to be created
before installing blfs-tool. You can place that directory anywhere, taking before installing blfs-tool. You can place this directory anywhere, taking
care that the builder user must have read and write privileges on that care that the user must have read and write privileges on that directory
directory and on all files it contains. and on all files it contains.
To use the default path set in the installation menu, run as root: To use the default path set in the installation menu, run as root:
@ -52,12 +52,12 @@ $Id$
3.2 BLFS_TOOL INSTALLATION:: 3.2 BLFS_TOOL INSTALLATION::
Run "make" to launch the jhalfs menuconfig interface. Select the BLFS Run "make" to launch the jhalfs menuconfig interface. Select the BLFS
book and it version. Then set the installation directory (default book and version. Then set the installation directory (default
$HOME/blfs_root), the BLFS sources directory (default blfs-xml), and $HOME/blfs_root), the BLFS sources directory (default blfs-xml), and
the installed packages tracking directory (default /var/lib/jhalfs/BLFS). the installed packages tracking directory (default /var/lib/jhalfs/BLFS).
All required files will be placed in the installation directory and All required files will be placed in the installation directory and
BLFS XML sources will be checkout to the named sub-directory. BLFS XML sources will be installed in the named sub-directory.
Installed files: Installed files:
@ -70,9 +70,9 @@ $Id$
update_book.sh update the XML book sources and regenerates packages update_book.sh update the XML book sources and regenerates packages
database and meta-packages dependencies tree database and meta-packages dependencies tree
gen_config.sh regenerates Config.in gen_config.sh regenerates Config.in
gen_pkg_book.sh solve dependencies and generates linear BLFS books gen_pkg_book.sh resolves dependencies and generates linear BLFS books
and build scripts and build scripts
gen-makefile.sh generates target Makefile gen-makefile.sh generates the target Makefile
progress_bar.sh the target Makefile progress bar progress_bar.sh the target Makefile progress bar
Makefile run gen_config.sh to update Config.in, Makefile run gen_config.sh to update Config.in,
then launch the menuconfig interface, and lastly run then launch the menuconfig interface, and lastly run
@ -89,118 +89,118 @@ $Id$
3.3 UPDATING BOOK SOURCES:: 3.3 UPDATING BOOK SOURCES::
If using the development book version, and if you want to update already If you are using the development book version and you want to update
installed packages to the new version found in that book, you need to update installed packages to the latest version found in that book, you need to
the XML sources and packages database. update the XML sources and packages database.
To do that run "./update_book.sh" To do that run "./update_book.sh"
On the next configuration run, packages already installed but listed On the next configuration run, packages already installed but listed
with a new version in the book will be available for target selection and with a new version in the book will be available for target selection
used to solve dependencies. and used to solve dependencies.
3.4 CONFIGURING AND PARSING THE BOOK:: 3.4 CONFIGURING AND PARSING THE BOOK::
Next step is to create a book and build scripts in dependencies build order The next step is to create a book and build scripts in dependency
for a target package. A target can be a package or a meta-package. build order for a target package. A target can be a package or a
meta-package.
WARNING: WARNING:
Only one target (meta-package or individual package) must be Only one target (meta-package or individual package) must be
selected on each configuration run. selected on each configuration run.
That is due that there is no way to solve dependencies properly There is no way to solve dependencies properly when more
when more than one target are selected at the same time. than one target are selected.
Run <make> to launch the configuration interface. The main menu contains Run <make> to launch the configuration interface. The main menu contains
three block: meta-package selection, individual package selection, and three blocks: meta-package selection, individual package selection, and
build options. build options.
When a meta-package is selected is possible to unselect unwanted components. When a meta-package is selected, it is possible to unselect unwanted
That unselected components will be skipped if no other components depends components. The unselected components will be skipped if no other components
on them. depends on them.
In the build options section the dependencies level and default packages In the build options section, the dependencies level and default packages
used to solve alternatives are set. Can be set also if the build will be used to solve alternatives are set. You can also select whether the build will
made as a normal user or as root. That settings are saved to be reused on be made as a normal user or as root. That settings are saved to be reused in
future configuration runs. future configuration runs.
If, for example, your target selection is Xsoft-->Graphweb-->galeon a If, for example, your target selection is Xsoft-->Graphweb-->galeon, a
directory named "galeon" will be created. Inside that directory you will directory named "galeon" will be created. Inside that directory you will
find a directory named "HTML" that contains a galeon-based HTML book with find a directory named "HTML" that contains a galeon-based HTML book with
its dependencies in build order, and a "scripts" directory with build its dependencies in build order, and a "scripts" directory with build
scripts for that packages. scripts for that packages.
There is also two other directories, "dependencies" and "xincludes", that There are also two other directories ("dependencies" and "xincludes")
contains files generated while resolving dependencies trees. that contain files generated while resolving dependencies trees.
3.5 EDITING BUILD SCRIPTS 3.5 EDITING BUILD SCRIPTS
Now is time to review the generated book and scripts, making in the Now it is time to review the generated book and scripts, making any changes
scripts any changes required to fix generation bugs or to fit your needs. to the scripts necessary to fix generation bugs or to suit your needs.
Scripts for additional packages (i.e., for non-BLFS packages) can be Scripts for additional packages (i.e., for non-BLFS packages) can be
inserted in an easy way due how the scripts are named. For example, if you easily inserted. For example, if you want to install the external dependency
want to install the external dependency "bar" before "foo" package and the "bar" before "foo" package and the "foo" script is named "064-z-foo", you
"foo" script is named "064-z-foo", you need to create a "064-y-bar" build need to create a "064-y-bar" build script.
script.
Remember that the packages tracking system isn't a packages management tool Remember, the package tracking system isn't a package management tool
and know nothing about packages not in the BLFS book. and knows nothing about packages not in the BLFS book.
Also, review and edit envars.conf. That file is used to set global envars Also, review and edit envars.conf. This file is used to set global envars
needed by the build scripts. needed by the build scripts.
3.6 CREATING THE MAKEFILE 3.6 CREATING THE MAKEFILE
When the build scripts are ready to be run, the Makefile can be When the build scripts are ready to be run, the Makefile can be
created. Be sure that you cd into the "package" directory and run created. Be sure that you cd into the "package" directory and run
../gen-makefile.sh
../gen_makefile.sh Review the Makefile, and, if all looks sane, start the build.
Review the Makefile and if all looks sane, start the build.
4. GENERATED BUILD SCRIPTS ISSUES:: 4. GENERATED BUILD SCRIPTS ISSUES::
In this section known issues with the generated build scripts are In this section, known issues with the generated build scripts are
discussed. They are due build procedures and/or BLFS layout particularities discussed. They are due to build procedures and/or BLFS layout particularities
than we can't handle. In several cases editing the build scripts is mandatory. that we can't handle. In several cases, editing the build scripts is mandatory.
You may need also to insert some build script created by you to resolve You may also need to insert some build scripts created by you to resolve
unhanded dependencies and/or to remove some script installing the affected unhandled dependencies and/or to remove some script installing the affected
package by hand. package by hand.
4.1 BLFS BOOTSCRIPTS 4.1 BLFS BOOTSCRIPTS
For now, bootscripts installation will fail. You will need to edit the For now, bootscripts installation will fail. You will need to edit
scripts for packages that install bootscripts and fix their installation the scripts for packages that install bootscripts and fix their
command. That could be fixed in the future, but not sure. installation command. That could be fixed in the future.
4.2 PACKAGES CONFIGURATION 4.2 PACKAGE CONFIGURATION
For that packages that have a "Configuration" section, you should to For those packages that have a "Configuration" section, you should
edit it build script to fit the configuration to your needs. edit the build script to fit the needs of your system.
4.4 PDL and Perl modules. 4.4 PDL and Perl modules.
The generated scripts for that packages are plainly broken and can't The generated scripts for these packages are broken and can not
be fixed. You must to replace it by your own ones or install that be fixed. You must replace them with your own scripts or install the
packages by hand. packages by hand.
4.4 GCC, JDK, Sane, and KDE-multimedia 4.4 GCC, JDK, Sane, and KDE-multimedia
On the pages for that packages, the BLFS book actually have instructions On the pages for these packages, the BLFS book actually has instructions
to install two packages. You must to edit the scripts to fix it. We will to install two packages. You must edit the scripts to fix this.
try to fix some of them, but may not be possible.
We will try to fix some of them, but this may not be possible.
4.5 XORG7 4.5 XORG7
The generated scripts for Xorg7 pseudo-packages don't have support for The generated scripts for Xorg7 pseudo-packages don't have support for
$SRC_ARCHIVE nor MD5 checking. $SRC_ARCHIVE nor MD5 checking.
If you has downloaded previously the packages, you must to edit the scripts If you have previously downloaded the packages, you must edit the
to make it to use your local packages. scripts to use your local packages.
Also, you will need to edit the scripts to fix the commands that must Also, you will need to edit the scripts to fix the commands that must
be applied only to a concrete individual sub-package. For example the "for" be applied only to a concrete individual sub-package. For example, the
loop to install xorg7-util packages may read like: "for" loop to install xorg7-util packages may read like:
for package in $(cat $WGET_LST) ; do for package in $(cat $WGET_LST) ; do
packagedir=$(echo $package | sed 's/.tar.bz2//') packagedir=$(echo $package | sed 's/.tar.bz2//')
@ -219,7 +219,7 @@ for package in $(cat $WGET_LST) ; do
rm -rf $packagedir rm -rf $packagedir
done done
After reading the HTML page to know what commands is for what package, After reading the HTML page to find what command is for what package,
the loop can be changed to read something like: the loop can be changed to read something like:
for package in $(cat $WGET_LST) ; do for package in $(cat $WGET_LST) ; do
@ -245,24 +245,24 @@ done
4.6 PATCHES 4.6 PATCHES
By default all required patches will be downloaded from the NET. By default, all required patches will be downloaded from the NET.
If you has downloaded previously the patches, you must to edit the scripts If you have previously downloaded the patches, you must edit the
to make it to use your local patches. scripts to use your local patches.
Also, be sure that all scripts have the commands to download/apply the Also, be sure that all scripts have the commands to download/apply the
required patches. Due book layout issues some patches may be missing. required patches. Due to book layout issues, some patches may be missing.
4.7 ROOT COMMANDS 4.7 ROOT COMMANDS
If building as a normal user (the default setting) be sure that all If building as a normal user (the default setting), be sure that all
commands that need root privileges are run using sudo. commands that require root privileges are run using sudo.
Due book layout issues some sudo command may be missing. Due to book layout issues, some sudo commands may be missing.
4.8 OTHERS 4.8 OTHERS
May have other issues that we are not aware on them yet. If you find There may be other issues that we are not aware of. If you find
someone, please report it to <alfs-discuss@linuxfromscratch.org>. any, please report it to <alfs-discuss@linuxfromscratch.org>.