home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD1.iso / Editor / DVD!FX17.LHA / FrexxEd / fpl / RCSControl.FPL.README < prev    next >
Encoding:
Text File  |  1995-02-26  |  4.3 KB  |  94 lines
  1. #############################################################################
  2. File:                RCSControl
  3. Author:                Jesper Skov
  4. Email:                jskov@iesd.auc.dk
  5. Short:                Easy RCS control from FrexxEd
  6. Version:            1.3
  7. Date:                26.02.95
  8. Local settings:
  9. Global settings:
  10. Keysequence:        'C-x C-q' and 'C-x C-Q'
  11. Type:                function
  12. Prereq:                WriteProtect.FPL
  13. Copyright:            © 1994-1995, Jesper Skov
  14.                     Use/distribute according to the terms of GNU GPL.
  15.                     (See the file 'COPYING.GNU' for more info!)
  16. #############################################################################
  17.  
  18. FUNCTION
  19.   This RCS control interface will give you a very easy way of bumping and
  20.   describing your code/text revisions.
  21.   The backbone of this control is the possibility of write protecting a
  22.   buffer, which (by ways of incredible luck :) is provided by
  23.   FrexxEd. With this write protection (wp) it is _very_ simple for
  24.   you to see if you have "control" over a given buffer - you will not be
  25.   able to change the buffer if not. Now you may wonder what wp has to do with
  26.   revision control... Um, very good question actually. I guess the answer is
  27.   >nothing< :) Oh well, maybe a little; on UN*X machines (multi user
  28.   environment) where (many) different people may work with the same files, it
  29.   is often desirable to lock out other users while a file is changed. To
  30.   control this "who's-changing-what-and-when" problem some smart guys invented
  31.   'revision control systems', which also keep track of changes and history.
  32.   Now, such a system has been ported to the Amiga and why not use what is at
  33.   hand? I know that there exist "history control systems" and RC systems
  34.   written for the Amiga, but I just happen to know this system from school:
  35.   GNU RCS. The Amiga port is done by Heinz Wrobel and is called `HWGRCS'.
  36.   You can find the archive on AmiNet (and Fish, I guess) where it is called
  37.   `HWGRCSp?f.lha'. The '?' indicates the latest patch level number (I use
  38.   level 10). You will have to put the RCS files in a directory accessible
  39.   with the assign "bin:" (e.g. copy them to C: and assign bin: to C:).
  40.  
  41.   Wow, lotsa text about nothing... Still with me? OK, operation:
  42.   First time invoked on a (non-wp) file: You will be asked if the file should
  43.   be put under RCS control.
  44.     -- NO : buffer will be writeprotected.
  45.     -- YES: You will be asked if an RCS directory should be created if not
  46.             already there (this will keep your directory tiddier :)
  47.             Then you will be told (or reminded, whatever) that the first
  48.             comment entry is used for file description.
  49.   2nd+ time invoked (non-wp):
  50.     A comment buffer will be opened where you may enter revision specific
  51.     information. Only when you press C-c C-c will the revision update take
  52.     effect, in which case the file is locked (checked in) and the buffer is
  53.     write protected (the comment buffer disappears). You may explicit cancel
  54.     the locking by pressing C-g, which will kill the comment buffer.
  55.   If invoked on a write protected buffer, the buffer is made changeable
  56.   (de-wp'ed =) and if the file is under RCS control it will be unlocked,
  57.   checked out (see TO DO).
  58.  
  59.   You can also use the sequence C-x C-Q which will do a normal check in,
  60.   followed immediately by a check out. Use this to bump the revision when
  61.   you want to continue editing.
  62.  
  63.   If you want to use this system you should also have a good long look at
  64.   the RCS documentation (and perhaps one at my code so you know what's
  65.   going on :)
  66.  
  67.   Invoke the function RCSMakeHistory to extract a file's history. The output
  68.   is by default redirected to filename.history.
  69.  
  70.  
  71. TO DO
  72.   I have a fab idea for Amiga revision bumping combined with building a
  73.   usable history file... Wait'n'C!
  74.  
  75. HISTORY (REV)
  76.   26.02.95 (3)    Check in speed up (see bugs).
  77.                 Code cleaned up.
  78.   05.02.95 (2)    Problems with FrexxEd's writeprotection fixed.
  79.   26.10.94 (1)    Added the RCSMakeHistory function.
  80.   25.10.94 (0)    Initial revision.
  81.  
  82. BUGS
  83.   When you bump a file (C-x C-Q) FrexxEd will complaint (when you try to save
  84.   it again) that the file has been changed on disk. This is because check in
  85.   is now done without re-loading the file (speed-up). You'll have to do a
  86.   "manual override" for now... I'll have a chat with Daniel about a proper
  87.   solution =)
  88.   
  89.   Other bug reports to my EMail address, thanks.
  90.  
  91. SEE ALSO
  92.   RCS documentation (not included)
  93.   Michael Crichton's "Congo" (ISBN:0-14-00-5863-X)
  94.