home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 3 / goldfish_volume_3.bin / files / dev / misc / makeversion / makeversion.doc < prev    next >
Text File  |  1994-10-15  |  5KB  |  144 lines
  1.  
  2.              MAKEVERSION
  3.  
  4.            written by Ben Hutchings
  5.          and released as version 1.0
  6.               in September 1994
  7.  
  8.  
  9. NOTE: This program is for OS 2.0 and above, only.
  10.  
  11.  
  12. LEGAL
  13.  
  14. The contents of this package are the files:
  15.     MakeVersion, MakeVersion.doc, MakeVersion.doc
  16.  
  17. These files are copyright (c) Ben Hutchings 1994, but they
  18. may be freely distributed provided
  19. (i)   no charge is made for them above the costs of
  20.       duplication, distribution and the media used,
  21. (ii)  all the listed files are kept together, and
  22. (iii) the files are unaltered.
  23. The exception to (iii) is that the files may be distributed
  24. in a compressed form as long as the original files can be
  25. retrieved from this form unchanged.
  26.  
  27. Software released under these conditions is often known as
  28. Freeware.
  29.  
  30. I reject any responsibility for any undesirable consequences
  31. whatever of the use of this software. This includes, but is
  32. not limited to, secondary consequences, personal injuries or
  33. other kinds of side effects.
  34.  
  35.  
  36. INTRODUCTION
  37.  
  38. MakeVersion is a simple program for creating program version
  39. numbers. I use it to embed version numbers in most of my
  40. publicly-released programs. It creates linkable object files
  41. which can be used by any standard Amiga linker when linking
  42. the program and is particularly suitable for use in Make
  43. files (or Lmk or DMake files).
  44.  
  45.  
  46. INSTALLATION
  47.  
  48. It is best to copy the program onto your hard disk or
  49. compiler boot disk before using it.
  50.  
  51. · Boot from your normal compiler disk (this should be a COPY
  52.   of the original disk) or hard disk.
  53. · Open a Shell/CLI.
  54. · Enter 'Resident C:Copy pure' (this may cause an error, but
  55.   that doesn't matter - unless it says 'object not found' in
  56.   which case sorry, you're a bit stuck!).
  57. · Insert the disk this text is on.
  58. · Change the current directory to the directory this text is
  59.   in - you will have to type something like
  60.   'CD DF0:MakeVersion'.
  61. · If you have two floppy drives or a hard drive, then enter
  62.   'Copy MakeVersion C:'.
  63. · If you have only one drive, then enter
  64.   'Copy MakeVersion RAM:', then 'Copy RAM:MakeVersion C:',
  65.    then 'Delete RAM:MakeVersion'.
  66. · Enter 'EndCLI' to close the Shell/CLI.
  67.  
  68.  
  69. HOW TO USE THE PROGRAM
  70.  
  71. To create the first version file (1.0) for a program in
  72. development, you type the command:
  73.  
  74.     MakeVersion <prog-name>
  75.  
  76. A file called <prog-name>_ver will be created containing
  77. the text "1.0". Another file called <prog-name>_ver.o will
  78. contain the text "$VER: <prog-name> 1.0 (<date>)" as a code
  79. hunk. You should then include this file in your links, and
  80. if you use Make or a similar utility you should edit your
  81. Make-file to include the MakeVersion command immediately
  82. before each link. This will ensure that the date is always
  83. correct.
  84. To update the version files to the next revision (e.g. from
  85. "1.0" to "1.1" or from "1.23" to "1.24") you should use the
  86. command:
  87.  
  88.     MakeVersion <prog-name> next
  89.  
  90. To make a major version change, simply use the command:
  91.  
  92.     Echo <version> ><prog-name>_ver
  93.  
  94. For example, to change the version of MyProg to 2.0, type:
  95.     Echo 2.0 >MyProg_ver
  96.  
  97. Then just run MakeVersion as normal or (if you use a utility
  98. such as Make, let that run it automatically before the next
  99. link).
  100.  
  101. Alternatively, if the next revision of the program will be a
  102. major version change, use:
  103.  
  104.     Echo <version> ><prog-name>_ver_next
  105.  
  106. The version number you give will be used the next time you
  107. request a new revision (with the NEXT keyword - see above).
  108.  
  109.  
  110. FORMAL REFERENCE
  111.  
  112. Format:   MAKEVERSION [PROGRAM] <name> [NEXT]
  113.  
  114. Template: PROGRAM/A,NEXT/S
  115.  
  116. Purpose:  To create or update a version string in a linkable
  117.       object file.
  118.  
  119. Specification:
  120.  
  121. MakeVersion will read any existing version file, named
  122. "<name>_ver" or, if one does not exist, create one contain-
  123. ing the number "1.0", and add the current date to the
  124. version number in Commodore's standard version date format
  125. to make a version string. The version string, along with the
  126. identifier "$VER: " will be written to the file
  127. "<name>_ver.o" as a CODE segment.
  128. If the NEXT switch is used, the file "<name>_ver_next" will
  129. be read, or, if one does not exist, the normal file will be
  130. read and its revision number incremented. The new version
  131. number will be written to the file "<name>_ver", and the
  132. file "<name>_ver_next" will be deleted if it exists.
  133.  
  134.  
  135. CONTACT ME
  136.  
  137. As yet I can only be contacted by Snail-mail.
  138. My address is:
  139.  
  140.         43 Harrison Close
  141.         Reigate
  142.         Surrey RH2 7HS
  143.         ENGLAND
  144.