src/WINNT/install/InstallShield5/README.TXT

   1 Copyright 2000, International Business Machines Corporation and others.
   2 All Rights Reserved.
   3
   4 This software has been released under the terms of the IBM Public
   5 License.  For details, see the LICENSE file in the top-level source
   6 directory or online at http://www.openafs.org/dl/license10.html
   7
   8 HOW TO USE THIS MESS
   9
  10 TO EDIT THE IS5 FILES
  11
  12 If you need to modify the InstallShield project files, follow these steps:
  13
  14 0)  Go to the src dir version of the install files.
  15
  16 1)  Run the batch file CreateISDirs.bat
  17         This will create the directories that IS needs.  We can't store these
  18     dirs in CML because the directory names contain spaces.
  19
  20 2)  Run the batch file ScatterFiles.bat
  21         This will copy the IS files that are in the main install dir to the
  22     appropriate IS dirs.
  23
  24 3)  Run the batch file CreateGeneratedFiles.bat
  25     This will run other batch files that will generate certain IS files that
  26     we can't use directly.  This is because the IS IDE puts paths in those
  27     files that are relative to the machine the IDE is running on.  If some
  28     other person doing a build used a different drive mapping to get at the
  29     build tree, the IS build would fail.  These batch files will generate the
  30     IS files such that the paths will be relative to the person doing the
  31         build.
  32
  33 4)  Run InstallShield and load the InstallShield5.ipr project file.
  34     It is called InstallShield5.ipr, and not something more appropriate like
  35     TransarcAFS.ipr, because IS requires that the project name match the
  36     name of the directory in which the project lives.
  37
  38 5)  Do whatever it is you need to do to the IS5 project.
  39
  40 6)  CML edit the files in the main install dir.
  41
  42 7)  If you changed the file groups, you must go into the File Groups dir and
  43     modify the GenFileGroups.bat file.  If you changed an existing file group,
  44     then you must make the change again in the batch file.  If you have deleted
  45     a file group, then you must delete it from the batch file.  If you added a
  46     group, then add it to the batch file.
  47
  48 7)  Run the batch file GatherFiles.bat.
  49     This will get all the IS5 files out of their IS5 dirs and copy them into
  50     the main install dir.
  51
  52 8)  If you have added or deleted file groups, edit the batch file DelISDirTree.bat.
  53     It removes the file group files, so modify its list to match what currently
  54     is in use.
  55
  56 9) Run the batch file DelISDirTree.bat.
  57     This will delete all of the IS dirs.  Some of the dirs, like the media build
  58     report dirs, are always removed.  Most other dirs are removed only if they
  59     are empty.  Any dirs not removed after running the batch file contain files
  60     that we previously didn't know about, so IS had some reason to create them
  61     for the first time.  You will have to determine if the file should be added
  62     to cml.  If it should be added, then check to see if it contains path names.
  63     If it does, then you must create a batch file to generate this new file.
  64     Look at GenFileGroups.bat for an example of how to do that.  In either case
  65     you have a new file to add to the build tree, either the new file IS made or
  66     your batch file that generates the IS file.  Copy this file to the main
  67     install dir (rename it if it clashes with a file already there), and modify
  68     ScatterFiles.bat, GatherFiles.bat, and DelISDirTree.bat to include the new
  69     file.
  70
  71     Also, if you had to create a batch file to generate the IS file, then modify
  72     CreateGeneratedFiles.bat to include a call to your batch file.
  73
  74 10) Do a cml close.  If you want to diff the IS5 files, do so only on the setup.rul
  75     file.  IS5 reoriganizes most other files more or less randomly each time
  76     they are saved.  It's easist to just edit all the files and then check in all
  77     of them.  However, if you know IS well and you know which files your changes
  78     have affected, then only check in those files.
  79
  80
  81
  82 HOW TO BUILD THE SETUP PROJECT
  83
  84 0)  Go to the obj dir version of the install files.
  85
  86 1)  To build the distribution type:
  87          nmake /f NTMakfile install
  88
  89     If the build fails, you may not have the environment variable IS5ROOT
  90     defined.  Define it and try again.
  91
  92     If it still fails, then you're on your own.  Use your excellent debugging
  93     skills to fix the problem.
  94