home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d5xx / d502 / autorev.lha / AutoRev / AutoRev.DOC < prev    next >
Text File  |  1991-06-27  |  7KB  |  163 lines
  1.  
  2.                           AutoRev  version 1.1r
  3.  
  4.                     © Copyright 1991 Jaba Development
  5.                           Written using  DICE C
  6.                           by  Jan van den Baard
  7.  
  8.  
  9.  DISCLAIMER
  10.  ---------------------------------------------------------------------------
  11.  The author is not resposible for any damage caused by  the use or misuse of
  12.  this documentation and/or the program(s) it describes. Any damage resulting
  13.  from  the use  or  misuse of this  documentation  and/or the  program(s) it
  14.  describes is the sole responsibility of the user her/him self.
  15.  ---------------------------------------------------------------------------
  16.  
  17.  COPYRIGHT
  18.  ---------------------------------------------------------------------------
  19.  AutoRev,  © Copyright 1991  Jaba Development.  All  rights  reserved.  This
  20.  program may be distributed non-commercially only providing that  the source
  21.  code, documentation and  copyright notices  remain intact and  are included
  22.  in the distribution. This program is FREEWARE so no financial donations are
  23.  required (I'd rather have some new PD).
  24.  ---------------------------------------------------------------------------
  25.  
  26.  AutoRev is a little utility to make it easy to update program-headers. It's
  27.  a CLI command which can be called like this:
  28.  
  29.     AutoRev <filename> [ASSEM] [MODULA] [UPDATE] [BOTTOM]
  30.                        [AUTHOR <name>] [COPYRIGHT <string>]
  31.                        [REVISION <string>] [COMMENT <string>]
  32.                        [TRANSLATOR <string>]
  33.  
  34.  Possible argument abbrevations:
  35.  
  36.         ASS = ASSEM           MOD = MODULA            UPD = UPDATE
  37.         BOT = BOTTOM          AUT = AUTHOR            COP = COPYRIGHT
  38.         REV = REVISION        COM = COMMENT           TRA = TRANSLATOR
  39.  
  40.  Here is an explanation of the possible arguments:
  41.  
  42.     filename   - This is a required argument which specifies the name of the
  43.                  header file you  wish to create or  the source you  wish to
  44.                  update.
  45.  
  46.     ASSEM      - Pass this  in the argument line  if you  wish to  create an
  47.                  assembler source code header. This option is only used when
  48.                  creating a header.
  49.  
  50.     MODULA     - The  same  as ASSEM  only  this  time  it creates a MODULA/
  51.                  OBERON  source header.  If  "MODULA" and/or "ASSEM" are not
  52.                  specified it will create a C source header.
  53.  
  54.     UPDATE    -  This  tells  AutoRev to  update  the  source by inserting a
  55.                  "history line"  in  the  file it's header.  It  this  isn't
  56.                  specified  AutoRev  creates a  source  header.  If  AutoRev
  57.                  finds that the  file  it should  create already  exists  it
  58.                  asks you if you want to overwrite it. Be very carefull  not
  59.                  to overwrite important data!
  60.  
  61.     BOTTOM    -  By default AutoRev will insert the  "history lines" on  top
  62.                  of the other already existing  "history lines". This  tells
  63.                  AutoRev  to  insert  the  "history-line"  below  the  other
  64.                  "history-lines". This  should  be used in combination  with
  65.                  the "UPDATE" option.
  66.  
  67.     AUTHOR    -  This enables you to specify the  author of the source code.
  68.                  This option should be used when  creating a source  header.
  69.                  The name should not be  longer than 52  characters.
  70.  
  71.     COPYRIGHT -  This enables  you to specify  some  copyright  information.
  72.                  This option should be used when  creating a source  header.
  73.                  The string should not be longer than 52 characters.
  74.  
  75.     REVISION  -  This enables you to specify the current revision.  This can
  76.                  be  used  when  creating  or  updating source  headers. The
  77.                  string should not be longer than 7 characters.
  78.  
  79.     COMMENT   -  This enables  you to add  some additional  comments to  the
  80.                  revision.  This can  be  used  when  creating  or  updating
  81.                  source headers. The string  should  not be  longer  than 42
  82.                  characters.
  83.  
  84.     TRANSLATOR - This  enables you  to add  information  about the name  and
  85.                  version  of  the  compiler/assembler  you  are using.  This
  86.                  option should be  used when  creating a  source header. The
  87.                  string should not be longer than 52 characters.
  88.  
  89.  For example if you type the following sequence in the CLI:
  90.  
  91.     AutoRev rev.mod MODULA AUTHOR "Mr. Modula" COPYRIGHT "© 1991"
  92.             REVISION 0.06a COMMENT "Who cares ?" TRANSLATOR M2Amiga
  93.  
  94.  It will create the following header:
  95.  
  96. (*-- AutoRev header do NOT edit!
  97. *
  98. *   Program         :   rev.mod
  99. *   Copyright       :   © 1991
  100. *   Author          :   Mr. Modula
  101. *   Creation Date   :   04-Apr-91
  102. *   Current version :   0.06a
  103. *   Translator      :   M2Amiga
  104. *
  105. *   REVISION HISTORY
  106. *
  107. *   Date          Version         Comment
  108. *   ---------     -------         ------------------------------------------
  109. *   04-Apr-91     0.06a           Who cares ?
  110. *
  111. *-- REV_END --*)
  112.  
  113.  As you can see AutoRev automatically inserts the correct date if the system
  114.  time is set correct.  Just load the created  file into your  favorite  text
  115.  editor and start  your program at the  bottom of the header.  When you have
  116.  updated your program with (for example) a directory routine you  can update
  117.  the source header by typing the following sequence in the CLI:
  118.  
  119.     AutoRev rev.mod UPDATE REVISION 0.07 COMMENT "Added directory routine."
  120.  
  121.  Now the source will look like this:
  122.  
  123. (*-- AutoRev header do NOT edit!
  124. *
  125. *   Program         :   rev.mod
  126. *   Copyright       :   © 1991
  127. *   Author          :   Mr. Modula
  128. *   Creation Date   :   04-Apr-91
  129. *   Current version :   0.07
  130. *   Translator      :   M2Amiga
  131. *
  132. *   REVISION HISTORY
  133. *
  134. *   Date          Version         Comment
  135. *   ---------     -------         ------------------------------------------
  136. *   04-Apr-91     0.07            Added directory routine.
  137. *   04-Apr-91     0.06a           Who cares ?
  138. *
  139. *-- REV_END --*)
  140.  
  141. Your program........
  142.  
  143.  As you can see there is a "history line" added to the list and the  current
  144.  revision number  has been updated.  If you  do not  specify a  new revision
  145.  string the last revision is used again.  Also the old source  code has been
  146.  renamed to "rev.mod.old".  I have  incoorporated this feature to  make sure
  147.  that,  if something goes wrong (who knows ?),  you still have  the original
  148.  source. If you want the new "history line" at the  bottom of  the list  you
  149.  should specify "BOT" or "BOTTOM" in the argument list.
  150.  
  151.  This program REQUIRES kickstart 2.0 to work  ( almost every  system routine
  152.  called is kickstart 2.0 only! ).  You should  NOT edit in the source header
  153.  between the  line that  reads "Current version :" and  the line that  reads
  154.  "-- REV_END --"  because AutoRev depends on the  data between these  lines.
  155.  AutoRev is pure so it can be made resident.
  156.  
  157.  Happy revising....
  158.  
  159.                                                 Jan van den Baard
  160.                                                 Bakkerstraat 176
  161.                                                 3082 HE, Rotterdam
  162.                                                 The Netherlands
  163.