config

   1 /*
   2  *      aegis - project change supervisor
   3  *      This file is in the Public Domain, 1995, Peter Miller.
   4  *
   5  * MANIFEST: example use of make in project config file
   6  *
   7  * The make(1) program exists in many forms, usually one is available with each
   8  * UNIX version.  The one used in the writing of this section is GNU Make 3.70,
   9  * avaiable by anonymous FTP from your nearest GNU archive site.  GNU Make was
  10  * chosen because it was the most powerful, it is widely avaiable (usually for
  11  * little or no cost) and discussion of the alternatives (SunOS make, BSD 4.3
  12  * make, etc), would not be universally applicable.  "Plain vanilla" make
  13  * (with no transitive closure, no pattern rules, no functions) is not
  14  * sufficiently capable to satisfy the demands placed on it by aegis.
  15  *
  16  * As mentioned in the Dependency Maintenance Tool chapter of the User Guide,
  17  * make is not really sufficient, because it lacks dynamic include dependencies.
  18  * However, GNU Make has a form of dynamic include dependencies, and it has a
  19  * few quirks, but mostly works well.
  20  *
  21  * The other feature lacking in make is a search path.  While GNU Make has
  22  * functionality called VPATH, the implementation leaves something to be
  23  * desired, and can't be used for the search path functionality required by
  24  * aegis.  Because of this, the create_symlinks_before_build field of the
  25  * project config file is set to true so that aegis will arrange for the
  26  * development directory to be fiull of symbolic links, making it appear that
  27  * the entire project is in each change's development directory.
  28  */
  29
  30 /*
  31  * The build_command field of the project config file is used to invoke the
  32  * relevant build command.  This command tells make where to find the rules.
  33  * The ${s Makefile} expands to a path into the baseline during development
  34  * if the file is not in the change.  Look in aesub(5) for more information
  35  * about command substitutions.
  36  */
  37 build_command = "SCONS_LIB_DIR=${Development_Directory}/src/engine python ${Source src/script/scons.py} date='${DAte %Y/%m/%d %H:%M:%S}' developer=${DEVeloper} version=${VERsion} change=${Change}";
  38
  39 /*
  40  * The rules used in the User Guide all remove their targets before
  41  * constructing them, which qualifies them for the following entry in the
  42  * config file.  The files must be removed first, otherwise the baseline would
  43  * cease to be self-consistent.
  44  */
  45 link_integration_directory = true;
  46
  47 /*
  48  * Another field to be set in this file is one which tells aegis to maintain
  49  * symbolic links between the development directory and the basline.  This also
  50  * requires that rules remove their targets before constructing them, to ensure
  51  * that development builds do not attempt to write their results onto the
  52  * read-only versions in the baseline.
  53  */
  54 create_symlinks_before_build = true;
  55
  56 /*
  57  * NOT UNTIL AEGIS 3.23; we may not need it anyway.
  58 remove_symlinks_after_build = false;
  59  */
  60
  61 /*
  62 integrate_begin_command =
  63         "";
  64 */
  65
  66 /*
  67  *      aegis - project change supervisor
  68  *      This file is in the Public Domain, 1995, 1998 Peter Miller.
  69  *
  70  * MANIFEST: example of using rcs in the project config file
  71  *
  72  * The entries for the commands are listed below.  RCS uses a slightly
  73  * different model than aegis wants, so some maneuvering is required.
  74  * The command strings in this section assume that the RCS commands ci and co
  75  * and rcs and rlog are in the command search PATH, but you may like to
  76  * hard-wire the paths, or set PATH at the start of each.  You should also note
  77  * that the strings are always handed to the Bourne shell to be executed, and
  78  * are set to exit with an error immediately a sub-command fails.
  79  *
  80  * In these commands, the RCS file is kept unlocked, since only the owner will
  81  * be checking changes in.  The RCS functionality for coordinating shared
  82  * access is not required.
  83  *
  84  * One advantage of using RCS version 5.6 or later is that binary files are
  85  * supported, should you want to have binary files in the baseline.
  86  *
  87  * The ${quote ...} construct is used to quote filenames which contain
  88  * shell special characters.  A minimum of quoting is performed, so if
  89  * the filenames do not contail shell special characters, no quotes will
  90  * be used.
  91  */
  92
  93 /*
  94  * This command is used to create a new file history.
  95  * This command is always executed as the project owner.
  96  * The following substitutions are available:
  97  *
  98  * ${Input}
  99  *      absolute path of the source file
 100  * ${History}
 101  *      absolute path of the history file
 102  *
 103  * The "ci -f" option is used to specify that a copy is to be checked-in even
 104  *      if there are no changes.
 105  * The "ci -u" option is used to specify that an unlocked copy will remain in
 106  *      the baseline.
 107  * The "ci -d" option is used to specify that the file time rather than the
 108  *      current time is to be used for the new revision.
 109  * The "ci -M" option is used to specify that the mode date on the original
 110  *      file is not to be altered.
 111  * The "ci -t" option is used to specify that there is to be no description
 112  *      text for the new RCS file.
 113  * The "ci -m" option is used to specify that the change number is to be stored
 114  *      in the file log if this is actually an update (typically from aenf
 115  *      after aerm on the same file name).
 116  * The "rcs -U" option is used to specify that the new RCS file is to have
 117  *      unstrict locking.
 118  * The "rcs -kk" option is used to specify that keyword substitution is
 119  *      disabled (only keyword names, not values, are substituted).
 120  */
 121 history_create_command =
 122         "ci -f -u -d -M -m$c -t/dev/null ${quote $input} ${quote $history,v}; \
 123 rcs -kk -U ${quote $history,v}";
 124
 125
 126 /*
 127  * This command is used to get a specific edit back from history.
 128  * This command is always executed as the project owner.
 129  * The following substitutions are available:
 130  *
 131  * ${History}
 132  *      absolute path of the history file
 133  * ${Edit}
 134  *      edit number, as given by history_\%query_\%command
 135  * ${Output}
 136  *      absolute path of the destination file
 137  *
 138  * The "co -r" option is used to specify the edit to be retrieved.
 139  * The "co -p" option is used to specify that the results be printed on the
 140  *      standard output; this is because the destination filename will never
 141  *      look anything like the history source filename.
 142  * The "rcs -kk" option is used to specify that keyword substitution is
 143  *      disabled (only keyword names, not values, are substituted).
 144  */
 145 history_get_command =
 146         "co -kk -r${quote $edit} -p ${quote $history,v} > ${quote $output}";
 147
 148 /*
 149  * This command is used to add a new "top-most" entry to the history file.
 150  * This command is always executed as the project owner.
 151  * The following substitutions are available:
 152  *
 153  * ${Input}
 154  *      absolute path of source file
 155  * ${History}
 156  *      absolute path of history file
 157  *
 158  * The "ci -f" option is used to specify that a copy is to be checked-in even
 159  *      if there are no changes.
 160  * The "ci -u" option is used to specify that an unlocked copy will remain in
 161  *      the baseline.
 162  * The "ci -d" option is used to specify that the file time rather than the
 163  *      current time is to be used for the new revision.
 164  * The "ci -M" option is used to specify that the mode date on the original
 165  *      file is not to be altered.
 166  * The "ci -m" option is used to specify that the change number is to be stored
 167  *      in the file log, which allows rlog to be used to find the change
 168  *      numbers to which each revision of the file corresponds.
 169  *
 170  * It is possible for a a very cautious approach has been taken, in which case
 171  * the history_put_command may be set to the same string specified above for
 172  * the history_create_command.
 173  */
 174 history_put_command =
 175         "ci -f -u -d -M -m$c ${quote $input} ${quote $history,v}";
 176
 177 /*
 178  * This command is used to query what the history mechanism calls the top-most
 179  * edit of a history file.  The result may be any arbitrary string, it need not
 180  * be anything like a number, just so long as it uniquely identifies the edit
 181  * for use by the history_get_command at a later date.  The edit number is to
 182  * be printed on the standard output.  This command is always executed as the
 183  * project owner.
 184  *
 185  * The following substitutions are available:
 186  *
 187  * ${History}
 188  *      absolute path of the history file
 189  */
 190 history_query_command =
 191         "rlog -r ${quote $history,v} | awk '/^head:/ {print $$2}'";
 192
 193 /*
 194  * RCS also provides a merge program, which can be used to provide a three-way
 195  * merge.  It has an ouput format some sites prefer to the fmerge output.
 196  *
 197  * This command is used by aed(1) to produce a difference listing when a file
 198  * in the development directory is out of date compared to the current version
 199  * in the baseline.
 200  *
 201  * All of the command substitutions described in aesub(5) are available.
 202  * In addition, the following substitutions are also available:
 203  *
 204  * ${ORiginal}
 205  *      The absolute path name of a file containing the common ancestor
 206  *      version of ${MostRecent} and {$Input}.  Usually the version originally
 207  *      copied into the change.  Usually in a temporary file.
 208  * ${Most_Recent}
 209  *      The absolute path name of a file containing the most recent version.
 210  *      Usually in the baseline.
 211  * ${Input}
 212  *      The absolute path name of the edited version of the file.  Usually in
 213  *      the development directory.
 214  * ${Output}
 215  *      The absolute path name of the file in which to write the difference
 216  *      listing.  Usually in the development directory.
 217  *
 218  * An exit status of 0 means successful, even of the files differ (and they
 219  * usually do).  An exit status which is non-zero means something is wrong.
 220  *
 221  * The "merge -L" options are used to specify labels for the baseline and the
 222  *      development directory, respecticvely, when conflict lines are inserted
 223  *      into the result.
 224  * The "merge -p" options is used to specify that the results are to be printed
 225  *      on the standard output.
 226  */
 227
 228 diff3_command =
 229         "set +e; \
 230 merge -p -L baseline -L C$c ${quote $mostrecent} ${quote $original} \
 231 ${quote $input} > ${quote $output}; \
 232 test $? -le 1";
 233
 234 diff_command =
 235         "set +e; \
 236         diff -c ${quote $original} ${quote $input} > ${quote $output}; \
 237         test $? -le 1";
 238
 239 /*
 240  * We use an intermediary test.pl script to execute tests.
 241  * This serves as glue between the tests themselves (which are
 242  * written to conform to Perl conventions) and Aegis' expectations.
 243  * See the comments in the test.pl script itself for details.
 244  */
 245 test_command = "python ${Source runtest.py Absolute} -b aegis -q -v ${VERsion} ${File_Name}";
 246
 247 new_test_filename = "test/CHANGETHIS.py";
 248
 249 /*
 250  *
 251  */
 252 file_template =
 253 [
 254         {
 255                 pattern = [ "src/engine/*__init__.py" ];
 256                 body = "${read_file ${source template/__init__.py abs}}";
 257         },
 258         {
 259                 pattern = [ "src/engine/*Tests.py" ];
 260                 body = "${read_file ${source template/Tests.py abs}}";
 261         },
 262         {
 263                 pattern = [ "src/engine/*.py" ];
 264                 body = "${read_file ${source template/file.py abs}}";
 265         },
 266         {
 267                 pattern = [ "test/*.py" ];
 268                 body = "${read_file ${source template/test.py abs}}";
 269         },
 270 ];