home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 640a.lha / Bump_v1.0 / Bump.DOC < prev    next >
Text File  |  1992-05-15  |  4KB  |  113 lines
  1.  
  2.                                Bump v1.0
  3.  
  4.               --> A tool to keep your sources up-to-date <--
  5.  
  6.                            KICKSTART 2.0 ONLY
  7.  
  8.                                    by
  9.  
  10.                             Jan van den Baard
  11.  
  12.                              This program is
  13.                                 FREEWARE
  14.  
  15.             and remains (c) Copyright 1992 Jaba Development
  16.  
  17.   The author cannot be held liable for  the suitability  or accuracy  of this
  18. program.   Any damage directly or indirectly caused by the use or  misuse  of
  19. of this program is the sole responsibility of the user her/him self.
  20.  
  21.   Bump is a little utility to make it easy to keep the version string in your
  22. sources up-to-date. It's ment to be called from the cli or a makefile. Here's
  23. how to call it:
  24.  
  25.   Format:     Bump <Name> [INCVER] [INCREV] [SETVER = num] [SETREV = num]
  26.                    [QUIET] [ONLYDATE]
  27.  
  28.   Template:   Name/A,INCVER/S,INCREV/S,SETVER/K/N,SETREV/K/N,QUIET/S,
  29.               ONLYDATE/S
  30.  
  31.   With:
  32.               Name     = The name  of  the  source  code  which  contains the
  33.                          version string that must be updated.
  34.  
  35.               INCVER   = Specifying this  argument   causes  the  program  to
  36.                          increase the version number by one.
  37.  
  38.               INCREV   = Specifying this  argument   causes  the  program  to
  39.                          increase the revision number  by one.    This is the
  40.                          default setting.
  41.  
  42.               SETVER   = With this argument you can set the version number to
  43.                          what you want.
  44.  
  45.               SETREV   = With  this argument  you can set the revision number
  46.                          to what you want.
  47.  
  48.               QUIET    = Specifying this will prevent Bump from printing  the
  49.                          progress information on the console.
  50.  
  51.               ONLYDATE = This  specifies  that bump must only re-set the date
  52.                          in the version string.
  53.  
  54.   Purpose:    To update the version string in a source code file.
  55.  
  56.   Specification:
  57.     BUMP reads the source code file into memory and  searches for the  string
  58.     "$VER: ". This is identifies the version string.   If  this is  found the
  59.     program  looks  through  the  version  string  to  find  the  version and
  60.     revision numbers.     Then it updates  these  numbers and writes the file
  61.     back to the disk. NOTE:  The version  string  must be formed as described
  62.     in the  "User Interface  Style  Guide"  which  is  as follows:
  63.  
  64.             $VER: <name> <version>.<revision> (<d>.<m>.<y>)
  65.  
  66.             <name>      The name of the program.
  67.             <version>   Major version number.
  68.             <revision>  Minor revision number.
  69.             <d>         Day in month created (number)
  70.             <m>         Month created (number)
  71.             <y>         Year created (number)
  72.  
  73.     The  program  counts  the  '.', '(' and ')'  characters that occur in the
  74.     version string and if it doesn't check out the program exits.    When you
  75.     have an  assembler program called "blurp" created on  friday  the seventh
  76.     of february 1992 and it's version is 37.295  the  string should  be coded
  77.     as follows:
  78.  
  79.             version_string:
  80.                     dc.b    '$VER: BLURP 37.295 (7.2.92)',0
  81.  
  82.     When the next day you add a feature you  should call  Bump the  following
  83.     way before assembling the source:
  84.  
  85.             Bump Blurp.s INCREV
  86.  
  87.     After this the version string has been changed to the following:
  88.  
  89.             version_string:
  90.                     dc.b    '$VER: BLURP 37.296 (8.2.92)',0
  91.  
  92.     The same thing can be done with C sources.
  93.  
  94.             UBYTE *version_string = "$VER: BLURP 37.295 (7.2.92)";
  95.  
  96.     After you call Bump Blurp.c INCREV the line with the version string reads
  97.  
  98.             UBYTE *version_string = "$VER: BLURP 37.296 (8.2.92)";
  99.  
  100.     As you can see BUMP automatically changes the date to the system  time so
  101.     be  sure that  your clock  is set correctly.  BUMP is pure an can be made
  102.     resident.
  103.  
  104.   Bug reports,  suggestions,  postcards,  flames,  criticism,  contributions,
  105. ideas, gifts, etc., etc., etc......... to:
  106.  
  107.                                            Jan van den Baard
  108.                                            Bakkerstraat 176
  109.                                            3082 HE, Rotterdam
  110.                                            The Netherlands
  111.  
  112.                                            FIDO: 2:500/29 (Jan van.den.Baard)
  113.