home *** CD-ROM | disk | FTP | other *** search
/ Microsoft Programmer's Library 1.3 / Microsoft-Programers-Library-v1.3.iso / sampcode / alde_c / lattice / errmerge / errmerge.doc < prev   
Encoding:
Text File  |  1988-08-09  |  5.5 KB  |  120 lines
  1.      ERRMERGE.COM - A Pre-C(tm)/Lattice C(tm) source code correction aid.
  2.  
  3. |    Version 1.01
  4.  
  5.  
  6. |    usage: errmerge [-h] filename
  7.      
  8.      where: filename is the name of the file containing the error messages
  9.             produced by Lattice or Pre-C.
  10.             
  11. |           -h is an option which allows the processing of #included files
  12. |           (those files which do not have a ".c" or ".C" extension).
  13.  
  14.  
  15.      ERRMERGE will read a file containing Lattice C or Phoenix Pre-C error
  16.      messages (perhaps others, read the assumptions below), and will merge
  17.      the error messages before the referenced lines in your source files.
  18. |    Error messages will be inserted in only those files which have a ".c"
  19. |    or ".C" extension unless the -h command line option is included.
  20.  
  21.      Error messages are inserted as comments, so they will not disturb
  22.      compilation.  Error messages take the form:
  23.  
  24.                /* ERR: (compiler/analyzer message here) */
  25.  
  26.      The ERR: is inserted to aid in finding error lines with your text
  27.      editor search function.  Error messages are inserted starting at the
  28.      first column so they will stand out in indented source code.
  29.  
  30.      To assist in removing the error messages from your source code after
  31.      repairs have been made, the program ERRKILL has been provided.
  32.      ERRKILL uses a work file and creates a backup (contain the error
  33.      messages) as described for ERRMERGE below.
  34.  
  35.      ERRKILL will search a source file for comments beginning with ERR: as
  36.      described above and remove them.
  37.  
  38.  
  39.      Creating the error file:
  40.  
  41.      The error file may be created by redirecting output from the Lattice
  42.      C compiler or the Pre-C syntax analyzer to a DOS text file.  The
  43.      error file should have the same name as the C source file, with the
  44.      extension ".ERR".
  45.  
  46.      For Lattice C, redirection should be accomplished as specified in the
  47.      Lattice C manual, with the redirection operator preceding other
  48.      command line options.
  49.  
  50.      For Phoenix Pre-C, redirection is accomplished by following the Pre-C
  51.      command line with "> filename.err" where filename is the name of the
  52.      source file you are checking.  If several source files are analyzed
  53.      at the same time with Pre-C, ERRMERGE will merge the generated error
  54.      messages with the appropriate source files in one operation.
  55.  
  56.  
  57.      Other files and disk space usage:
  58.  
  59.      Before merging error messages into a source file, a backup file will
  60.      be created.  The backup file will be an exact copy of the C source
  61.      file, with the extension ".BAK".  If a backup file (filename.bak)
  62.      already exists, none will be created.
  63.  
  64.      In addition to the backup file, ERRMERGE uses a temporary work file
  65.      which will grow as large as the original source file plus the error
  66.      text to be merged.  The temporary file is deleted automatically
  67.      before ERRMERGE exits.
  68.  
  69.      You must have enough free space to hold the error file, source
  70.      file(s), backup file(s) and the temporary work file.
  71.  
  72.  
  73.      Assumptions:
  74.  
  75.      It is assumed that the error file and source files are in the same
  76.      sub-directory.
  77.  
  78.      In analyzing error messages, some assumptions have been made:
  79.  
  80.         1) Every line to be considered as an error message (in the error
  81.            file) must contain the word "Error" or "Warning" within the
  82.            first 40 characters of the error message.
  83.  
  84.         2) Every line should contain a line number, and this number must
  85.            be the first number within the error message (if your source
  86.            file name contains a number, ERRMERGE will not work
  87.            properly).  If a line does not contain a line number, it will
  88.            be assigned the line number 1, and will be merged at the
  89.            beginning of the source file.  If the error line number is 0,
  90.            it will be converted to 1, and will be inserted at the
  91.            beginning of the source file.
  92.  
  93.         3) Every line should contain the name of the source file which
  94.            produced the error, and this file name must appear just prior
  95.            to the line number (separating spaces are ok).  The source
  96.            file name must contain an extension.
  97.  
  98.      If your compiler or analyzer generates error messages which meet the
  99.      above requirements, it may work properly with ERRMERGE.
  100.  
  101.  
  102.      Credits:
  103.  
  104.      ERRMERGE was written (and is copyrighted) by Leroy Casterline, and is
  105.      distributed as "ShareWare".  If you find this program useful, please
  106.      consider a contribution ($10 suggested).  Source code will be
  107.      provided (if requested and a self-addressed mailer with diskette and
  108.      postage is sent with your contribution).
  109.  
  110.      Please send suggestions, bug reports and contributions to:
  111.  
  112.                           Leroy Casterline
  113.  
  114.                           Casterline Computer Consulting
  115.                           2507 West Laurel Street
  116.                           Fort Collins, Colorado  80521
  117.  
  118.                           (303) 223-3490/484-9858
  119.  
  120.