source: README@ d44206f

$Id$

1. INTRODUCTION::

     This collection of scripts, known as jhalfs, strives to create
  accurate makefiles from the Linux From Scratch book series XML files.
  This software is an evolution of the original "jhalfs-0.2" code.

     The usage of this script assumes you have read and are familiar with
  the book(s) and, therefore, the configuration variables found in config
  files will have meaning to you. There are a number of command line switches
  which, if used, will override the config file settings.

  NOTES::
  *.  The resulting Makefile takes considerable time to run to completion.
  Lay in a supply of caffeine beverages.

  *.  It is recommended that you temporarily unpack your linux kernel,
  run <make menuconfig>, configure the kernel as per the book and save
  the resulting .config file. This suggestion also applies to the
  configuration of the uClibc package when building a HLFS system using
  uClibc rather than glibc.

2. PREREQUISITES::

     To use this tool you MUST:

     - have experience building {c,h,b}LFS packages
     - know how to edit and write shell scripts
     - know how a Makefile works
     - be able to trace build failures and to find what is causing it
       (user error, package bug, {c,h,b}LFS command bug, or jhalfs code bug)

     If you do not have the above skills, please don't use this tool.


3. INSTALLATION::

     No installation is required. System-wide installation is not allowed
  for now.

4. CONFIGURATION FILES::

     ::NEWS:: There is new configuration method for jhalfs.

     We have installed the familiar menu based configuration tool driven by
     by GNU make. see the section RUNNING, for details

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
     recognize the layout from bulding the kernel or uClibc/Busybox. The
     underlying menu code was borrowed from BusyBox and slightly modified for 
     our use.

     Help on parameter function is available from the online help.
     
     Once you have set the parameters you wish and have saved your work the 
     makefile will proceed to launch the jhalfs script. The script validate and
     present you with your selections which you may accept or reject.
     
     If you accepted the displayed settings jhalfs will proceed to create the
     makefile, optionally download packages.

     NOTE::    
     If you run the jhalfs script directly the only funcion you can select is to
     display the version number


6. LAYOUT::

        /CLFS/config
             /master.sh
             /xxxx.xsl

        /CLFS2/config
              /master.sh
              /xxxx.xsl

        /HLFS/config
             /master.sh
             /xxxx.xsl

        /LFS/config
            / master.sh
            /xxxx.xsl

        /common/config
               /common_functions
               /makefile_functions
               /func_check_versions.sh
               /func_validate_configs.sh

        /contrib/jhalfs-paco.patch

        /extras/do_copy_files
               /do_ica_prep
               /do_ica_work
               /farce
               /filelist

        README
        README.BLFS
        README.PACO
        TODO

        Config.in
        makefile
        jhalfs
        blfs-tool

7. FAQ::
    Q. "This 'help' file is very sparse"
    A. Yes, it is. This tool, jhalfs, is for those who understand the LFS books
       and wish to automate the build. 99% of any problems that arise can be
       solved by reading the book(s).

    Q. "It doesn't work!"
    A. Yes it does, try >> make
       Remember you must either be 'root' to run this script or have 'sudo' privileges.

    Q. "It still doesn't work"
    A. jhalfs was designed to work against the developement versions of the LFS
       series of books. Consequently changes in a book(s) sometimes breaks older
       versions of jhalfs. Before you start pulling out your hair download the
       latest version of jhalfs to see if that solves your problem.

    Q. "How do I specify the build location?"
    A. The original LFS document worked against the well known location /mnt/lfs.
       This script automates the build of all of the LFS series of books and uses
       a generic location $BUILDDIR with a default value of /mnt/build_dir.
       You may change this value to suit your needs.

       The layout below $BUILDDIR is as follows.
       $BUILDDIR/
            jhalfs      (makefile,cmd scripts,logs..etc)
            sources     (where packages reside)
            tools       (temporary bootstrap system)
            cross-tools (temporary CLFS only)
                ...
            FHS dir structure
                ...

    Q. "What is the function of the SRC_ARCHIVE variable?"
    A. When then symlinked master.sh runs it creates a local copy of the
       necessary packages in BUILDDIR/sources by downloading the files. If
       the variable SRC_ARCHIVE is defined the software will first look in
       this location for the file and, if found, will copy it to BUILDDIR/sources.
       If the files are not found in SRC_ARCHIVE _and_ you have write priv to
       the directory any downloaded files will be mirrored there.

    Q. "How do I set the SRC_ARCHIVE location?"
    A. The best way to set the value of SRC_ARCHIVE is
       export SRC_ARCHIVE=/wherever/you/store/downloaded/packages
                       OR
       you can change the setting in common/config.

    Q. "Why have 2 copies of the files?"
    A. The package files must be visible during the chroot phase and this is a
       simple and reliable method of doing so. This method also handles the CLFS
       build method where the final build may be done on a separate machine.

    Q. "What is the function of LUSER and LGROUP? There is no cmd line switch"
    A. If you are running jhalfs from a low or non-priveledged account you may not
       have the priv to create/delete accounts. These variables are adjustable
       when invoking make.
         $BUILDDIR make LUSER=myaccount LGROUP=mygroup
       Then only changes to your account will be the creation of a NEW .bashrc after
       saving your original to .bashrc.XXX

    Q. "When I try to build 'xxx' with clfs the makefile fails at the mid-point"
    A. There could be numerous reasons for the failure but the most likely reason
       is you are doing a cross-build using the 'chroot' method and the target is
       not compatible with the host.  If you choose to build using the chroot
       method a test is performed at the end of the temptools phase. If the test
       succeeds the build continues inside a chroot jail. However if the test fails
       it means the host and target are not compatible an you should use the
       'boot' method to create your target code.
       As an extreme example: You can build a sparc target on a x86 platform but
       only the temptools phase. You must select the 'boot' method and not the 
       'chroot.' You must transfer the toolchain to a sparc platform, reboot the
       sparc box and continue the build.
       Of all the LFS series of books Cross-LFS requires the greatest
       understanding of host/target hardware combination. Please read the book
       carefully and don't skip the easy parts (there are none..)

Authors:
  George Boudreau
  Manuel Canales Esparcia
  Jeremy Huntwork