Changes between Version 2 and Version 3 of WPIBuild


Ignore:
Timestamp:
Jun 9, 2007, 11:58:54 PM (12 years ago)
Author:
jbs
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WPIBuild

    v2 v3  
    1717 2. From the base of the source subtree, use '''NMAKE ALL''' to ensure you have the latest binaries.
    1818 3. (Optional) Set environment variables to manage/customize the Warpin file creation. (See below for details.)
     19 4. If do not disable the build of an FM2UTILS WPI file, then you should...
     20  a. create a '''FM2UTILS''' subdiretory of the '''WARPIN''' subdirectory of the FM/2 source subtree.
     21  b. obtain a copy of '''FM2UTILS.ZIP''' and unzip it into this directory.
    1922 4. From the base of the source subtree, use '''NMAKE DIST''' which will compress the executables and build the WarpIN installation files.
    2023
     
    2326== Customizing the WPI build through environment variables. ==
    2427 BUILD_FM2UTILS::
    25   By default, a WPI file is cretaed for both FM/2 and the optional, separate FM/2 utilities package. To prevent the creation/update of the FM/2 Utilities WPI file, use '''SET BUILD_FM2UTILS=0'''.
     28  By default, a WPI file is created for both FM/2 and the optional, separate FM/2 utilities package. To prevent the creation/update of the FM/2 Utilities WPI file, use '''SET BUILD_FM2UTILS=0'''.
    2629 FM2_VER::
    2730  The WPI file for FM/2 is named '''FM2'''''<version-string>'''''.WPI'''. The ''<version-string>'' portion of the file name can be set through the '''FM2_VER''' environment variable. For example, '''SET FM2_VER=-3-5-9''' will result in '''FM2-3-5-9.WPI''' being created/updated.
     
    2932  The WPI file for FM/2 Utilities is named '''FM2UTILS'''''<version-string>'''''.WPI'''. The ''<version-string>'' portion of the file name can be set through the '''FM2UTILS_VER''' environment variable. For example, '''SET FM2UTILS_VER=-1-0-1''' will result in '''FM2UTILS-1-0-1.WPI''' being created/updated.
    3033
     34== Modifying the FM/2's WarpIN installation ==
    3135
     36=== Getting started ===
    3237
     38Before attempting to modify FM/2's WarpIN installation one should first read and understand the WarpIN Programmer's Guide and Reference. It will acquaint you with the general, technical details of creating WPI files. Then read and become familiar with FM/2's WarpIN script, '''FM2.WIS.IN''', which is found in the '''WARPIN''' subdirectory of the FM/2 source subtree. This will acquaint you with the specifics of how the current WarpIN installation of FM/2 is implemented.
     39
     40=== Overview ===
     41
     42Basically a WPI file contains a script and one or more packages. Each package contains zero or more files. The files within a package may be organized into directories. Users select packages to install and the directories into which each package is to be installed. Any directories that may exist within the package become subdirectories of the user-specified installation directory.
     43
     44Currently the directory structure (and the location of files therein) of the build subtree does not match the desired installation directory structure. Therefore the current build process for the WPI files includes the creation and population of "staging" directories from which the WPI file packages are created. So the "life cycle" of a file to be installed is:
     45 1. The FM/2 build process creates/updates the file within the build subtree
     46 2. The WPI portion of the build process copies these files from various locations within the build subtree into staging directories from which the files and subdirectories are then incorporated into packages within the WPI file(s)
     47 3. The files and subdirectories are installed into the user-selected installation directory during the installation of FM/2.
     48
     49Changes to the FM/2 Warpin installation will fall into three general categories:
     50 * Changes that only require script changes. Examples of these changes are:
     51  * Changes in package names
     52  * Changes in default proposed installation directories
     53  * Changes in the objects created
     54  * Changes names of or parameters passed to programs run during installation or de-installation (EXECUTE/DEEXECUTE)
     55  * Changes to certain text displayed in WarpIN windows during installation
     56  * Changes in whether or not '''CONFIG.SYS''' is updated
     57  * Changes in if or how OS2.INI is modified
     58 * Internal changes to the various REXX programs run via EXECUTE and DEEXECUTE statements within the script. If these changes require different parameters, then the script will need changing, too.
     59 * Changes which require changes to the staging process (and, possibly, changes to the script). Examples of these changes are:
     60  * Changes in package numbers (requires script change, too)
     61  * Adding new files and/or directories to be installed
     62  * Removing files and/or directories
     63  * Changes to the location where files are built or staged.
     64  * Changes to the names of files
     65  * Changes to the package numbers to which files are assigned
     66
     67=== How to modify the WarpIN installation ===
     68 * For script changes alter '''FM2.WIS.IN'''. Do NOT alter FM2.WIS!.
     69 * For internal changes to the REXX programs called via EXECUTE or DEEXECUTE, edit the appropriate file within the build subtree.
     70 * For changes which require changes to the staging process:
     71  1. Make appropriate changes, if any, to the build process. For example:
     72    * Cause new or renamed files and/or directories to be created.
     73    * Cause discontinued files to no longer be created.
     74  2. Alter '''BLD_FM2_WPIDIRS.TXT'''. This file is used to control which files from which build subtree directories are to be staged into which directories of which packages. '''BLD_FM2_WPIDIRS.TXT''' is self-documented. Read it to learn how to make changes to it.
     75