Changeset d7818f5 for README.BLFS

Timestamp:

02/24/2012 03:29:08 PM (12 years ago)

Author:

Pierre Labastie <pierre@…>

Branches:

ablfs

Children:

5e9076f

Parents:

96a30c7

Message:

Updates to README and README.BLFS. First "alpha release"

File:

• README.BLFS (modified) (12 diffs)

README.BLFS

@@ -46 +46 @@
 
        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 directory
-    which is created when needed during the process of building custom tools
-    or blfs tools, after xLFS. You can specify that directory location in
-    the blfs tools submenu of jhalfs. You may need to update permissions
-    and/or ownership of this directory before using the blfs tool.
-
-       The default location of the tracking directory is /var/lib/jhalfs/BLFS
+    initialized when <make> is first run in blfs_root. It resides in a
+    directory, which is created when needed during the process of building
+    custom tools or blfs dependencies, right after xLFS. You can specify
+    that directory location in the blfs-tools submenu of jhalfs. You may
+    need to update permissions and/or ownership of this directory before
+    using the blfs tool (see README in jhalfs).
+
+       The default location of the tracking directory is /var/lib/jhalfs/BLFS.
+    NB : after the initial build, that directory is only used to contain
+    instpkg.xml
 
   3.2  BLFS_TOOL INSTALLATION::
@@ -64 +67 @@
     root directory of the new xLFS system, which contains the followings:
 
-    blfs-xml/*         SVN tree of the selected BLFS book version
-    lib/*              functions libraries 
-    menu/*             lxdialog and menuconfig source code
-    xsl/*              XSL stylesheets used at several stages of the process
-    README.BLFS        this file
-    TODO               developers notes (well, not often updated)
-    gen_pkg_book.sh    resolves dependencies and generates linear BLFS books
-                       and build scripts
-    gen-makefile.sh    generates the target Makefile
-    progress_bar.sh    the target Makefile progress bar
-    gen-special.sh     Helper script for generating the package database
-    Makefile           Used by make to update the package database from the SVN
-                       tree, then launch the menuconfig interface, and run
-                       gen_pkg_book.sh based on configuration settings
-    packages.xml       auto-generated packages database
-    packdesc.dtd       a simple DTD describing the format of the package
-                       database
-    envars.conf        envars needed when running the target build scripts
+    blfs-xml/*              SVN tree of the selected BLFS book version
+    lib/constants.inc       functions libraries 
+       /func_dependencies     for building the dependency tree
+    menu/*                  lxdialog and menuconfig source code
+    xsl/gen_pkg_list.xsl    XSL stylesheet to generate the package database
+       /gen_config.xsl      XSL stylesheet to generate the Config.in file
+                            for use in the menuconfig system
+       /dependencies.xsl    XSL stylesheet to generate the dependency list
+                            of a package
+       /make_book.xsl       XSL stylesheet to generate the linear book.xml
+       /scripts.xsl         XSL stylesheet to generate the scriptlets from
+                            book.xml
+       /bump.xsl            XSL stylesheet to generate to update the tracking
+                            file
+    README.BLFS             this file
+    TODO                    developers notes (well, not updated often)
+    gen_pkg_book.sh         resolves dependencies and generates linear BLFS
+                            books and build scripts
+    gen-makefile.sh         generates the target Makefile
+    progress_bar.sh         the target Makefile progress bar
+    gen-special.sh          Helper script for generating the package database
+    Makefile                Used by make to update the package database from
+                            the SVN tree, then launch the menuconfig interface,
+                            and run gen_pkg_book.sh based on configuration
+                            settings
+    packdesc.dtd            a simple DTD describing the format of the package
+                            database and the tracking file.
+    envars.conf             envars needed when running the target build scripts
+
+  Several files are generated during the process:
+
+    packages.xml            auto-generated packages database
+    Config.in               input file for the menu driven choices
+    configuration           file generated by the menuconfig process
+    dependencies/*          files recording the dependency tree
+    book.xml                the linearized book
+    book-html/*             the linearized book rendered in html
+    scripts/*               the scriptlets
 
        From now on, all the work must be done from inside the installation
@@ -93 +116 @@
        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
-    update the XML sources and packages database.
+    update the XML sources and packages database. This is not necessary if
+    you just built xLFS, and you can skip to step 3.4.
 
        To do that run "make update". It may happen that the subversion
@@ -114 +138 @@
 
        In the build options section, the dependencies level and default packages
-    used to solve alternatives are set (currently, only for the mTA). You can
+    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.
     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!
 
        When you are done with the menu, a few checks occur, and the book is
@@ -129 +157 @@
     You have therefore to choose whether A is built before C, or
     C before A: the system cannot make that choice (well, maybe in a few
-    year, with an AI system able to understand the book). if you answer no,
+    year, with an AI system able to understand the book). If you answer no,
     C is built first. If you answer yes, C is put in place of A as a dependency
     of B, then the tree dependency restarts from there, that is with the
@@ -145 +173 @@
     generated while resolving dependencies.
 
-  3.5  EDITING BUILD SCRIPTS
+  3.5  EDITING BUILD SCRIPTS::
 
        Now it is time to review the generated book and scripts, making any
@@ -162 +190 @@
     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
@@ -181 +209 @@
    package by hand.
 
-   4.1  BLFS BOOTSCRIPTS
+   4.1  BLFS BOOTSCRIPTS::
 
       Normally, bootscript installation should work. On the other hand, the
    book does not give instruction for running them, so you might have to
-   manually insert /etc/init.d/<initscript> at some place during the build.
-
-   4.2  PACKAGE CONFIGURATION
+   manually insert /etc/init.d/rd.d/<initscript> at some place during the build.
+
+   4.2  PACKAGE CONFIGURATION::
 
       For those packages that have a "Configuration" section, you should
@@ -195 +223 @@
    at some point during the build.
 
-   4.4  GCC, JDK, Sane, and KDE-multimedia, freetype2, MesaLib and others
+   4.3  GCC, JDK, Sane, and KDE-multimedia, freetype2, MesaLib and others
 
         On the pages for those packages, the BLFS book actually has instructions
@@ -203 +231 @@
         We will try to fix some of them, but this may not be possible.
 
-   4.5  XORG7
+   4.4  XORG7
 
         The generated scripts for Xorg7 packages have $SRC_ARCHIVE
@@ -216 +244 @@
      used. Thus don't reuse previously existing ones.
 
-       In the script for xorg7-font, be sure to move the fonts directories
-     symlinks creation to after the "for ... done" loop.
-
-   4.6  PATCHES
+   4.5  PATCHES
 
         By default, all required patches will be downloaded from the NET.
@@ -229 +254 @@
      required patches. Due to book layout issues, some patches may be missing.
 
-   4.7  ROOT COMMANDS
+   4.6  ROOT COMMANDS
 
         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
-     necessary root privilege commands are visible in your PATH.
+     necessary root privilege commands are visible in your PATH. Or use
+     the `Defaults secure_path=' in /etc/sudoers. Also, the scripts use a
+     fragile construct:
+       sudo bash -c '<commands to be executed as root>'
+     which fail if the commands to be executed contain themselves a ' or access
+     a bash variable $XXX. So carefully review them.
 
         Due to book layout issues, some sudo commands may be missing.
 
-   4.8  OTHERS
+   4.7  OTHERS
 
         There may be other issues that we are not aware of. If you find
      any, please report it to <alfs-discuss@linuxfromscratch.org>.
 
-
+        Presently, there is an error in the book in file
+     x/installing/x7proto.xml. You should change the role='required' to
+     role='optional' in the optional dependencies, if you plan to build
+     X.