Update README.BLFS for envars.conf removal
And try to clarify... Also remove references to books other than LFS.
This commit is contained in:
parent
267b19da59
commit
0495e57e0a
1 changed files with 114 additions and 101 deletions
171
README.BLFS
171
README.BLFS
|
@ -11,10 +11,11 @@
|
||||||
build scripts and Makefile will work "as is", thus, as a general rule,
|
build scripts and Makefile will work "as is", thus, as a general rule,
|
||||||
you will need to review and edit the scripts while reading the book.
|
you will need to review and edit the scripts while reading the book.
|
||||||
|
|
||||||
Since version 3.0 of jhalfs, the blfs tools allow also to update packages
|
The blfs tools allow also to update packages from the LFS book. LFS
|
||||||
from the LFS book. LFS packages which may be updated appear in the menu
|
packages which may be updated appear in the menu interface. When selected,
|
||||||
interface. When selected, their scriptlet is generated in the same manner
|
their scriptlet is generated in the same manner as for BLFS packages.
|
||||||
as for BLFS packages.
|
(TODO: presently, when an LFS package needs a patch, you'll have to
|
||||||
|
donwload it manually to your $SRC_ARCHIVE directory (usually /sources)).
|
||||||
|
|
||||||
2. PREREQUISITES::
|
2. PREREQUISITES::
|
||||||
|
|
||||||
|
@ -24,8 +25,8 @@
|
||||||
- recommended: wget (to download the package tarballs) and sudo (to build
|
- recommended: wget (to download the package tarballs) and sudo (to build
|
||||||
as a user)
|
as a user)
|
||||||
- optional: lynx (allows to read the generated linearized book), GPM (to
|
- optional: lynx (allows to read the generated linearized book), GPM (to
|
||||||
cut and paste commands from the book), subversion (to update the book
|
cut and paste commands from the book), git (to update the book
|
||||||
sources), openssl (used by wget for all https:// sites)
|
sources)
|
||||||
Note that the optional dependencies are recommended for ease of use of the
|
Note that the optional dependencies are recommended for ease of use of the
|
||||||
tool.
|
tool.
|
||||||
|
|
||||||
|
@ -51,23 +52,20 @@
|
||||||
Select "Use Book --> Beyond Linux From Scratch" in the jhalfs menu:
|
Select "Use Book --> Beyond Linux From Scratch" in the jhalfs menu:
|
||||||
The tools are installed in $HOME$BLFS_ROOT (the default for $BLFS_ROOT
|
The tools are installed in $HOME$BLFS_ROOT (the default for $BLFS_ROOT
|
||||||
is /blfs_root). The BLFS book is downloaded or copied to its directory.
|
is /blfs_root). The BLFS book is downloaded or copied to its directory.
|
||||||
The tracking directory (see below) is initialized but not created: before
|
The tracking directory (see below) is created (if it does not already
|
||||||
the installation, you should ensure the tracking directory (default location
|
exist) and initialized. Before running "make", you should ensure the
|
||||||
/var/lib/jhalfs/BLFS) exists and is writable by the user. After the
|
tracking directory (default location /var/lib/jhalfs/BLFS) can be:
|
||||||
intallation, you should perform the following additional steps:
|
- either created by the user running "make", if it does not exist
|
||||||
|
- or that it is writable by the user running "make", if it exists.
|
||||||
- Configure sudo, adding the needed privileges for the user. For
|
|
||||||
newer sudo version, do not forget to add a line `Defaults secure_path='
|
|
||||||
containing /sbin and /usr/sbin (in /etc/sudoers), otherwise some
|
|
||||||
executables are not found.
|
|
||||||
|
|
||||||
|
After the intallation, you should perform the following additional steps:
|
||||||
|
- Configure sudo, adding the needed privileges for the user.
|
||||||
- Although it is not strictly necessary, it is recommended to install
|
- Although it is not strictly necessary, it is recommended to install
|
||||||
the bash shell startup files (as per `3. After LFS Configuration
|
the bash shell startup files (as per `3. After LFS Configuration
|
||||||
Issues' of the BLFS book), as some instructions in BLFS rely on
|
Issues' of the BLFS book), as some instructions in BLFS rely on
|
||||||
their being present.
|
their being present.
|
||||||
|
- At this point, the tool has no way to know which versions of LFS packages
|
||||||
- In this case, the tool has no way to know which version of LFS packages
|
are installed, so that the menu interface will show all the LFS packages,
|
||||||
is installed, so that the menu interface will show all the LFS packages,
|
|
||||||
as if they were not installed. If you have a released version of LFS, or
|
as if they were not installed. If you have a released version of LFS, or
|
||||||
the date of your GIT version of LFS is known, you should run the
|
the date of your GIT version of LFS is known, you should run the
|
||||||
update-lfs.sh script. If you have updated some
|
update-lfs.sh script. If you have updated some
|
||||||
|
@ -80,19 +78,16 @@
|
||||||
tracking file. The only way is to create empty files with names
|
tracking file. The only way is to create empty files with names
|
||||||
<package>-<installed-version> in the tracking directory, and run the tool.
|
<package>-<installed-version> in the tracking directory, and run the tool.
|
||||||
|
|
||||||
3.2 INSTALLATION ON A JUST BUILT xLFS SYSTEM
|
3.2 INSTALLATION ON A JUST BUILT LFS SYSTEM
|
||||||
|
|
||||||
For books that support it (only LFS for jhalfs version 2.4),
|
For books that support it (only LFS),
|
||||||
there is an option to install the BLFS tools right after building
|
there is an option to install the BLFS tools right after building
|
||||||
the xLFS system: just tick `BOOK Settings/Add blfs-tool support' in
|
the LFS system: just tick `BOOK Settings/Add blfs-tool support' in
|
||||||
jhalfs configuration menu. The tools are installed in $BLFS_ROOT
|
jhalfs configuration menu. The tools are installed in $BLFS_ROOT
|
||||||
(default /blfs_root) on the xLFS system, and the dependencies are built
|
(default /blfs_root) on the LFS system, and the dependencies are built
|
||||||
at the end of the jhalfs run, before the custom tools.
|
at the end of the jhalfs run, before the custom tools.
|
||||||
|
|
||||||
(TODO: blfs-tools have not been tested with current (version 3.0) of CLFS,
|
After booting the new LFS system some steps are needed to finish
|
||||||
and certainly need some adaptation to run)
|
|
||||||
|
|
||||||
After booting the new xLFS system some steps are needed to finish
|
|
||||||
the installation of the automated tools:
|
the installation of the automated tools:
|
||||||
|
|
||||||
- A user account must be created. You must be logged on that user
|
- A user account must be created. You must be logged on that user
|
||||||
|
@ -113,7 +108,7 @@
|
||||||
the tool in this case, and there is no need to run the update-lfs.sh
|
the tool in this case, and there is no need to run the update-lfs.sh
|
||||||
script.
|
script.
|
||||||
|
|
||||||
We assume that the BLFS tools will be used on a booted xLFS system.
|
We assume that the BLFS tools will be used on a booted LFS system.
|
||||||
Using them to build BLFS packages in a chroot jail is also possible,
|
Using them to build BLFS packages in a chroot jail is also possible,
|
||||||
but not supported.
|
but not supported.
|
||||||
|
|
||||||
|
@ -123,7 +118,7 @@
|
||||||
lfs-xml/* GIT tree of the selected LFS book version
|
lfs-xml/* GIT tree of the selected LFS book version
|
||||||
lib/constants.inc functions libraries
|
lib/constants.inc functions libraries
|
||||||
/func_dependencies for building the dependency tree
|
/func_dependencies for building the dependency tree
|
||||||
menu/* lxdialog and menuconfig source code
|
menu/* menuconfig source code
|
||||||
xsl/gen_pkg_list.xsl XSL stylesheet to generate the package database
|
xsl/gen_pkg_list.xsl XSL stylesheet to generate the package database
|
||||||
/gen_config.xsl XSL stylesheet to generate the Config.in file
|
/gen_config.xsl XSL stylesheet to generate the Config.in file
|
||||||
for use in the menuconfig system
|
for use in the menuconfig system
|
||||||
|
@ -135,24 +130,29 @@
|
||||||
/scripts.xsl XSL stylesheet to generate the scriptlets from
|
/scripts.xsl XSL stylesheet to generate the scriptlets from
|
||||||
book.xml
|
book.xml
|
||||||
/bump.xsl XSL stylesheet to update the tracking file
|
/bump.xsl XSL stylesheet to update the tracking file
|
||||||
|
/process-install.xsl XSL stylesheet included by scripts.xsl, for
|
||||||
|
outputting cleanly install instructions
|
||||||
|
/process-replaceable.xsl XSL stylesheet included by scripts.xsl, for
|
||||||
|
generating correct instructions when a
|
||||||
|
<replaceable> tag is encountered.
|
||||||
README.BLFS this file
|
README.BLFS this file
|
||||||
TODO developers notes (well, not updated often)
|
TODO developers notes (well, not updated often)
|
||||||
gen_pkg_book.sh resolves dependencies and generates linear BLFS
|
gen_pkg_book.sh resolves dependencies, generates a linear BLFS
|
||||||
books and build scripts
|
book, and finally generates build scripts
|
||||||
gen-makefile.sh generates the 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
|
||||||
gen-special.sh Helper script for generating the package database
|
gen-special.sh Helper script for generating the package
|
||||||
Makefile Used by make to update the package database from
|
database
|
||||||
the GIT tree, then launch the menuconfig interface,
|
Makefile Used by make to update the package database
|
||||||
and run gen_pkg_book.sh based on configuration
|
from the GIT tree, then launch the menuconfig
|
||||||
settings
|
interface, and run gen_pkg_book.sh based on
|
||||||
packdesc.dtd a simple DTD describing the format of the package
|
configuration settings
|
||||||
database and the tracking file.
|
packdesc.dtd a simple DTD describing the format of the
|
||||||
envars.conf envars needed when running the target build scripts
|
package database and the tracking file.
|
||||||
|
|
||||||
Working files: several files are generated when first running the tool
|
Working files: several files are generated when first running the tool:
|
||||||
|
|
||||||
packages.xml auto-generated packages database
|
packages.xml auto-generated package database
|
||||||
Config.in input file for the menu driven choices
|
Config.in input file for the menu driven choices
|
||||||
configuration file generated by the menuconfig process
|
configuration file generated by the menuconfig process
|
||||||
dependencies/* files recording the dependency tree
|
dependencies/* files recording the dependency tree
|
||||||
|
@ -171,7 +171,7 @@ Working files: several files are generated when first running the tool
|
||||||
The tracking system itself is an XML file: instpkg.xml. It is
|
The tracking system itself is an XML file: instpkg.xml. It is
|
||||||
initialized when <make> is first run in blfs_root. It resides in a
|
initialized when <make> is first run in blfs_root. It resides in a
|
||||||
directory, which is created when needed during the process of building
|
directory, which is created when needed during the process of building
|
||||||
custom tools or blfs dependencies, right after xLFS. You can specify
|
custom tools or blfs dependencies, right after LFS. You can specify
|
||||||
that directory location in the blfs-tools sub-menu of jhalfs. You may
|
that directory location in the blfs-tools sub-menu of jhalfs. You may
|
||||||
need to update permissions and/or ownership of this directory before
|
need to update permissions and/or ownership of this directory before
|
||||||
using the blfs tool (see README in jhalfs).
|
using the blfs tool (see README in jhalfs).
|
||||||
|
@ -195,9 +195,9 @@ Working files: several files are generated when first running the tool
|
||||||
|
|
||||||
If you are using the development book version and you want to update
|
If you are using the development book version and you want to update
|
||||||
installed packages to the latest version found in that book, you need to
|
installed packages to the latest version found in that book, you need to
|
||||||
update the XML sources and packages database. This is not necessary if
|
update the XML sources and packages database. To do that, run
|
||||||
you just built xLFS, and you can skip to step 3.4. To do that, run
|
"make update". This is not necessary if you just built LFS, and you
|
||||||
"make update".
|
can skip to step 4.2.
|
||||||
|
|
||||||
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
|
with a new version in the book will be available for target selection
|
||||||
|
@ -209,17 +209,35 @@ Working files: several files are generated when first running the tool
|
||||||
build order for one or several packages.
|
build order for one or several packages.
|
||||||
|
|
||||||
Run <make> to launch the configuration interface. The main menu contains
|
Run <make> to launch the configuration interface. The main menu contains
|
||||||
two blocks: individual package selection, and build options.
|
four blocks: individual package selection, Build settings, Build layout,
|
||||||
|
and Optimization.
|
||||||
|
|
||||||
In the build options section, the dependencies level and default packages
|
In the package selection block, menus and submenus are organized
|
||||||
used to solve alternatives are set (currently, only for the MTA). You can
|
as the book's parts, chapters and sections. You can navigate those menus
|
||||||
also select whether the build will be made as a normal user or as root.
|
and select as many targets as you want. But we suggest to not select
|
||||||
Those settings are saved to be reused in future configuration runs.
|
|
||||||
|
|
||||||
Note that you may select as many targets as you want, not just one
|
|
||||||
as in the previous version of this tool. But we suggest to not select
|
|
||||||
too many at a time to be able to sort issues!
|
too many at a time to be able to sort issues!
|
||||||
|
|
||||||
|
In the "Build settings" submenu, the dependency level and default
|
||||||
|
packages used to solve alternatives are set (currently, only for the MTA).
|
||||||
|
You can also select whether the build will be made as a normal user or as
|
||||||
|
root, whether to use "porg style" package management, whether to remove
|
||||||
|
".la" files, and wheter statistics for the package are generated (build
|
||||||
|
time, memory footprint and "DESTDIR" install). If you use package
|
||||||
|
management, you have to enter the path to the packInstall.sh script too.
|
||||||
|
|
||||||
|
In the "Build layout" submenu, you can select where the source tarballs
|
||||||
|
reside and are downloaded, where the packages are built, and whether to
|
||||||
|
keep the build tree after installation.
|
||||||
|
|
||||||
|
In the "Optimization" submenu, you can select the number of parallel
|
||||||
|
jobs, and set the usual CFLAGS, CXXFLAGS, and LDFLAGS. the special
|
||||||
|
keyword "EMPTY" can be used for those flags to ensure they are unset.
|
||||||
|
|
||||||
|
Note that there are help strings associated to those menus. Please
|
||||||
|
read them for details!
|
||||||
|
|
||||||
|
Those settings are saved to be reused in future configuration runs.
|
||||||
|
|
||||||
When you are done with the menu, a few checks occur, and the dependency
|
When you are done with the menu, a few checks occur, and the dependency
|
||||||
chain is generated. Each dependency appears with its priority (required,
|
chain is generated. Each dependency appears with its priority (required,
|
||||||
recommended, optional, or external), and it's level. There is a root level
|
recommended, optional, or external), and it's level. There is a root level
|
||||||
|
@ -238,7 +256,7 @@ Working files: several files are generated when first running the tool
|
||||||
Furthermore, there is a directory "scripts", which contains the generated
|
Furthermore, there is a directory "scripts", which contains the generated
|
||||||
scriptlets.
|
scriptlets.
|
||||||
|
|
||||||
There is also another directory, "dependencies" that contains files
|
There is yet another directory, "dependencies" that contains files
|
||||||
generated while resolving dependencies.
|
generated while resolving dependencies.
|
||||||
|
|
||||||
4.3 EDITING BUILD SCRIPTS::
|
4.3 EDITING BUILD SCRIPTS::
|
||||||
|
@ -255,16 +273,14 @@ Working files: several files are generated when first running the tool
|
||||||
Remember, the package tracking system isn't a package management tool
|
Remember, the package tracking system isn't a package management tool
|
||||||
and knows nothing about packages not in the BLFS book.
|
and knows nothing about packages not in the BLFS book.
|
||||||
|
|
||||||
IMPORTANT: Review and edit envars.conf, at least after installing the
|
|
||||||
tool. This file is used to set global envars needed by the build scripts.
|
|
||||||
If you use package management, the variable JH_PACK_INSTALL should point to
|
|
||||||
the directory where the packInstall.sh script resides.
|
|
||||||
|
|
||||||
4.4 CREATING THE MAKEFILE::
|
4.4 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. Create an empty directory (for example "mkdir work") and cd
|
created. Create an empty subdirectory (for example "mkdir work") and cd
|
||||||
to that directory. Then run ../gen-makefile.sh
|
to that directory. Then run ../gen-makefile.sh. Note that the directory
|
||||||
|
is completely emptied before generating the Makefile, so to prevent
|
||||||
|
erasing useful data, the script ensures that the name of the current
|
||||||
|
working directory starts with "work".
|
||||||
|
|
||||||
Review the Makefile, and, if all looks sane, start the build by running
|
Review the Makefile, and, if all looks sane, start the build by running
|
||||||
"make".
|
"make".
|
||||||
|
@ -296,7 +312,7 @@ Working files: several files are generated when first running the tool
|
||||||
|
|
||||||
For those packages that have a "Configuration" section, you should
|
For those packages that have a "Configuration" section, you should
|
||||||
edit the build script to fit the needs of your system. Sometimes, the
|
edit the build script to fit the needs of your system. Sometimes, the
|
||||||
bash startup files are modified. The shipped 'envars.conf' contains a
|
bash startup files are modified. The generated scripts contain a
|
||||||
line 'source /etc/profile', which ensures that the proper environment
|
line 'source /etc/profile', which ensures that the proper environment
|
||||||
variables are used.
|
variables are used.
|
||||||
|
|
||||||
|
@ -317,7 +333,7 @@ Working files: several files are generated when first running the tool
|
||||||
breaks those pages into individual pages for each packages in the linear
|
breaks those pages into individual pages for each packages in the linear
|
||||||
book. Also, the menu gives the choice to select each package individually.
|
book. Also, the menu gives the choice to select each package individually.
|
||||||
|
|
||||||
To build the whole Xorg7 chapter, select twm. The (recommended)
|
To build the whole Xorg7 chapter, select xinit. The (recommended)
|
||||||
dependency chain brings in the whole set of Xorg packages.
|
dependency chain brings in the whole set of Xorg packages.
|
||||||
|
|
||||||
5.5 PATCHES
|
5.5 PATCHES
|
||||||
|
@ -330,28 +346,25 @@ Working files: several files are generated when first running the tool
|
||||||
|
|
||||||
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 require root privileges are run using sudo. Also make sure
|
commands that require root privileges are run using sudo. Also make sure
|
||||||
necessary root privilege commands are visible in your PATH. Or use
|
necessary root privilege commands are visible in your PATH. The scripts
|
||||||
the `Defaults secure_path=' in /etc/sudoers.
|
ensure that /usr/sbin is appended to the user's PATH when running
|
||||||
|
privileged commands.
|
||||||
|
|
||||||
For commands necessitating root privileges, the generated scripts wrap
|
For commands necessitating root privileges, the generated scripts wrap
|
||||||
them with the construct:
|
them with the construct:
|
||||||
sudo -E sh << ROOT_EOF
|
sudo -E sh -e << ROOT_EOF
|
||||||
<commands to be executed as root with `$', ``', and `\' escaped>
|
<commands to be executed as root with `$', ``', and `\' escaped>
|
||||||
ROOT_EOF
|
ROOT_EOF
|
||||||
The -E switch ensures the whole environment is passed to the
|
The "-e" switch to sh ensures the command block exits with error if an
|
||||||
commands to be run with root privileges. It is effective only if the
|
error occurs. The "-E" switch to sudo ensures the whole environment is
|
||||||
/etc/sudoers file contains `Defaults setenv', or SETENV in the user
|
passed to the commands to be run with root privileges. It is effective
|
||||||
attributes. If you think it is a security issue, you may forbid this
|
only if the /etc/sudoers file contains `Defaults setenv', or SETENV in
|
||||||
flag in /etc/sudoers, but then, you have to un-escape `$' for variables
|
the user attributes (this is implicit if the command the user is allowed
|
||||||
coming from the environment in the instructions.
|
to run is `ALL'). If you think it is a security issue, you may forbid
|
||||||
Although this construct is rather strong, it can fail in some corner
|
this flag in /etc/sudoers, but then, you have to un-escape `$' for
|
||||||
cases, so carefully review those instructions.
|
variables coming from the environment in the instructions. Although this
|
||||||
|
construct is rather strong, it can fail in some corner cases, so
|
||||||
WARNING: One variable from the environment is not passed through the
|
carefully review those instructions.
|
||||||
-E switch, namely PATH. This is because "sudo" always reset the PATH to
|
|
||||||
the default "secure_path". If you need to have the same PATH as the user
|
|
||||||
"root" would have, you may want to add "source /etc/profile" at the
|
|
||||||
beginning of the commands to be executed as root.
|
|
||||||
|
|
||||||
Due to book layout issues, some sudo commands may be missing.
|
Due to book layout issues, some sudo commands may be missing.
|
||||||
|
|
||||||
|
|
Reference in a new issue