home *** CD-ROM | disk | FTP | other *** search
/ Programmer's ROM - The Computer Language Library / programmersrom.iso / ada / manage / rtread.me < prev    next >
Encoding:
Text File  |  1988-05-03  |  3.3 KB  |  102 lines
  1. To build the requirements reference tool:
  2.  
  3.  1. Compile all the new abstractions (newabs.src) associated with this 
  4.     tool into a program library. 
  5.  
  6.  2. Compile everything named in the REQSREF.CO file into the program library
  7.     containing the abstractions or a sublibrary whose parent library contains 
  8.     all the abstractions.  REQSREF.CO lists file names in the correct
  9.     compilation order.
  10.  
  11.  3. Link REQSREF with the program library where everything was compiled.
  12.     To do this using the DEC Ada compiler type:
  13.     $ acs link reqsref
  14.  
  15. To run the tool on VMS:
  16.  
  17.  1. Define a logical symbol for the executable of REQSREF.  For example,
  18.  
  19.     REQSREF :== $DRB1:[NOSC.TOOLS.REQSREF]REQSREF.EXE
  20.  
  21.      NOTE: The full path name of the executable is required in the 
  22.      definition of the symbol.   The pathname given here is just an example
  23.      and will be different on your system.
  24.  
  25.  2. Enter the command with appropriate parameters.  For example,
  26.  
  27.     REQSREF (source_files => ("test.ada", "put.spc"), 
  28.              pairs_files => ("*.*pr"), output => "reqs.out"); 
  29.  
  30.     Entering the command REQSREF with no parameters gives a brief
  31.     description of how to use the tool.
  32.  
  33. Files contained in this directory:
  34.  
  35. REQSREF.CO  -- Compilation order for requirements reference sources
  36. REQSREF.EXE -- VMS 4.0 requirements reference executable
  37. REQSREF.CNT -- Ada source statment count
  38. READ.ME     -- This file
  39.  
  40. The [.SOURCE] subdirectory contains most of the sources that make up the 
  41. requirements reference tool.  Other sources are contained in the abstractions
  42. directory.
  43.  
  44. Files in [.SOURCE]:
  45.  
  46.     The source files which make up the requirements reference tool are as
  47.     follows:
  48.  
  49.     RDRIVER.ADA -- the driver which deals with the command line
  50.     REQS.SPC    -- the procedures which control gathering info and sorting
  51.     REQS.BDY
  52.     MERGE.SPC   -- the procedures which control the merging and reporting
  53.     MERGE.BDY
  54.     GETNEXT.SUB  -- A subunit of the lexer which returns non-comment tokens
  55.                     to the lexer and buffers comments
  56.  
  57.     The remaining files (RQS*.*) are generated when the grammar file is
  58.     processed (RQS.GRM).  
  59.  
  60. The [.TEST] subdirectory consists of several Ada source files which contain
  61. reference strings.
  62.  
  63. The following files can be used as input for testing the REQSREF tool.
  64. Use REQSTEST.COM in the TEST directory to verify that REQSREF still works
  65. after a modification or after rebuilding in a new environment.
  66.  
  67.     B910ACAB.ADA
  68.     MTEST.BDY
  69.     MTEST.SPC
  70.     KTEST.SPC
  71.     SPTEST.SPC
  72.     NONAME.SOM
  73.     RTEST.ADA
  74.     SORT.SPC
  75.     TEST2.SUB
  76.  
  77. After running the command file TESTRUN.COM, the following output files
  78. should be produced:
  79.  
  80.     B910ACAB.APR
  81.     MTEST.SPR
  82.     SPTEST.SPR
  83.     RTEST.APR
  84.     KTEST.SPR
  85.     NONAME.PR
  86.     RUN3.RPT
  87.     RUN4.RPT
  88.     SORT.SPR
  89.     TEST2.UPR
  90.  
  91. The [.DOC] subdirectory contains the documentation for the requirements 
  92. reference tool.
  93.  
  94. Files in [.DOC]:
  95.  
  96.     REQSREF.MEM -- requirements reference user's manual
  97.     REQSREF.RNO -- Runoff input for user's manual
  98.     RQS.LIS     -- Listing of requirements reference grammar.  The rule numbers
  99.                    in this file may be used to make changes to the case
  100.                    statement in the Apply_Actions subunit.
  101.  
  102.