Version Control

[mytekcontrols]

Well I've been actively using this software for a few days now, and I must say I am very impressed, and pleased with how it works.

Brian you stated:

What I am searching for is something that automatically increments the file name EVERY time a compile is done. Occasionally I find I make a 'minor' change, forget to update the file name or version, then find unexpected things got clobbered.

It doesn't quite work as you have outlined above, but I think the CS-RCS approach might still satisfy the essence of what you are looking for... namely, a way to recover from unexpected problems due to minor changes. The difference is that you have to manage the process.

Here's an overview on using CS-RSC:

The best way to use it, especially for people like me that use multiple include files, is to define a project folder and move all your working files into it. This is done by using the CS-RCS Properties part of the program (I wont get into this too much here, because it is well covered in the help file).

Once a project has been set-up and all the working folders are checked-in, the Document Explorer will now become your management tool for these files.
<div style="float:left; padding-left: 225px;"><b>Document Explorer</b></div>
<img src="http://www.picbasic.co.uk/forum/attachment.php?attachmentid=587&stc=1&d=1130783295 " style="clear: left;float: left; padding: 8px;">
From this window (available on desktop) you can see any files that have changed within the project being highlighted in blue, and unchanged as black (changed files are files that have been modified and saved).

To the far right is the version number assigned to the file the last time it was checked-in. Right click any file To obtain the Status, to Check-it-In, to Check-it-Out, to see the History of changes made, ect.

The RCS Status option is rather cool. It allows you to open a "Differences" window that lets you see the actually changes that have occured to file. In the example below, can be seen the line-by-line modifications, with deletions shown as crossed out red colored text. And stuff that was added, is shown in blue text.


<div style="float:right; padding-right: 200px;"><b>Differences Window</b></div>
<img src="http://www.picbasic.co.uk/forum/attachment.php?attachmentid=588&stc=1&d=1130783295 " style="clear: right;float:right; padding: 8px;">To review all the changes, you can use the arrow keys to step yourself through everything that is different from when the file was last checked-in.

To make this system really work well for you. It is important that you check-in files when you feel that you are at a stable or working version. Remember to do this before you go on to make additional changes, or to try out some new hack. This way if the changes really mess something up as Brian pointed out, you can always use the check-out feature to restore the file back to the last checked-in version. To help you analyze the multitude of checked-in versions that will inevitably accumulate, a note may be added to describe it, which can be seen by mousing over the file name (also available in the Revision Manager Window).

!!! IMPORTANT !!!
Only use check-out when you are certain that you no longer want the present un-checked in state of the file (the present working copy). Checking-out will over write it. If you are unsure about this, it is best to check-in the file, since you can always pull up a copy of any checked-in file you want.


<div style="float:left; padding-left: 225px;"><b>Revision Manager</b></div>
<img src="http://www.picbasic.co.uk/forum/attachment.php?attachmentid=586&stc=1&d=1130780524 " style="clear: left;float: left; padding: 8px;">
The Revision History option available from the right-click menu, opens up the Revision Manager. This is where you can review all the versions that were checked-in, see the notes on the changes that were made, and retrieve a copy of any previous version (an actual copy is made into the Project folder --- it does not over write the current version).

Milestones:
Sometimes it is desirable to mark a certain revision level as having some significance, or having achieved a milestone (i.e.; "released beta version", "production release", ect.). Using the Milestones feature from the Document Explorer menu, allows you to do this very thing. Milestones can also be retrieved, similar to the way the Revision Manager retrieves previously checked-in versions. I wont get into all the details about this feature, but it definately can help add another layer of organization to your project.

Well hopefully this gives you a good quick glance of the CS-RCS system, and also what it can do for you. Remember this tool is not just limited to use with your PBP source files, it could also give you version control of any other documention that you may have a need to track changes on.

And last, but not least, NO I am not affiliated with or get paid by Component Software the makers of the CS-RCS program I have described. I just like what I see, and I think it can be a great companion to PBP and/or MicroCode Studio.

(thank you Brian for starting this post, and opening my eyes