CodeGuide contains out-of-the-box version control support for CVS and Perforce and BitKeeper.
You need to have either CVS, Perforce or BitKeeper installed on your computer.
You need to have a running version control server and a client workspace on your computer.
You should know the basic concepts of modern version control systems like Client Workspace, Repository and the basic concepts of the version control system you are using.
More information on where to get help for CVS can be found in the Where to get help chapter in the First Steps section.
More information on where to get help for Perforce can be found in the Where to get help chapter in the First Steps section.
More information on where to get help for BitKeeper can be found in the Where to get help chapter in the First Steps section.
You can configure the version control support using the Tools | Configure version control... menu entry.
You will see this dialog. Choose a version control system and press Next >.
CVS (the Concurrent Versions System) is an open-source version control system.
Next you have to choose the client executable which is normally named cvs (Linux/Solaris/Mac OS X) or cvs.exe (Windows).
In the next step you can optionally specify a CVS repository. If you do not specify a repository the CVS client will infer it from the CVS directory which is contained in each directory under version control or the CVSROOT environment variable if no CVS directory is found. In general you should specify a repository here if you use only one remote repository. You should not specify a repository here if you are working with several distinct CVS repositories.
For more information on repository specifications consult the CVS documentation.
After pressing Finish the wizard configures several tools with which you can control CVS.
CVS Login |
You can use this tool to login to a remote server. You will be asked for password which will be stored in the .cvspass file in your home directory. |
CVS Commit project |
Commits the changes you have made to all files contained in the project source directories and their subdirectories to the repository. |
CVS Update project |
Updates all files contained in the project source directories and their subdirectories from the repository. |
CVS Add |
Adds the specified directory to the repository. |
CVS Commit |
Commits the changes you have made to all files contained in the specified directory and its subdirectories to the repository. |
CVS Update |
Updates all files contained in the specified directory and its subdirectories from the repository. |
CVS Status |
Shows the status of all files contained in the specified directory and its subdirectories. |
CVS Remove |
Schedules all files contained in the specified directory and its subdirectories for removal from the repository. You have to use CVS Commit to actually remove the files from the repository.
Please note that the files are not really removed from the repository. Check your CVS documentation for details on how CVS handles removal of files in the repository.
WARNING: The files are removed from the client workspace immediately. |
CVS Add |
Schedules the specified file for addition to the repository. You will be prompted to enter a description for this file.
You have to use CVS Commit to actually check the file into the repository. |
CVS Commit |
Commits the changes you have made to the specified file to the repository. |
CVS Update |
Updates the specified file from the repository (in case someone else has changed it). |
CVS Status |
Shows the status of the specified file (modified, unmodified, etc.) |
CVS Remove |
Schedules the specified file for removal from the repository. You have to use CVS Commit to actually remove the file from the repository.
Please note that the file is not really removed from the repository. Check the CVS documentation for details on how CVS handles removal of files in the repository.
WARNING: The specified file is removed from the client workspace immediately. |
CVS Log |
Show the change log for the specified file. |
CVS Edit |
Notifies CVS that you start editing the specified file. Write permission is turned on after using this command.
You need to use this only if this file is being watched. |
CVS Unedit |
Notifies CVS that you stop editing the specified file. Reverts the file to the repository version on which it is based. Write permission is turned off after using this command if this file is being watched.
You need to use this only if this file is being watched
WARNING: The specified file is reverted to its repository version discarding any changes you might have made. if you want to keep your changes use CVS Commit instead. |
You can edit the generated tools in the External Tools section of the Preferences Dialog.
Please note that your old settings are overwritten if you choose to configure CVS using this wizard again.
Perforce is a commercial version control system available from Perforce Software.
After choosing Perforce you have to specify the client executable which is normally named p4 (Linux/Solaris/Mac OS X) or p4.exe (Windows).
In the next step you can specify the host and the port number of the perforce server. This value has the form host:port (Example: perforce:1666). If you do not specify this the Perforce client will use the P4PORT environment variable.
After pressing Finish the wizard configures several tools with which you can control Perforce.
P4 Submit changes |
Submits the changes you have made to the depot. |
P4 Revert changes |
Reverts all changes you have made since the last submission and removes all open files from your changelist. |
P4 Sync workspace |
Brings the client workspace in sync by copying all modified files from the depot into your workspace. |
P4 Add |
Schedules the specified file for addition to the depot.
You have to use P4 Submit Changes to actually add the file into the depot. |
P4 Delete |
Schedules the specified file for deletion from the depot. You have to use P4 Submit Changes to actually remove the file from the depot.
Please note that the file is not really removed from the depot. Check the Perforce documentation for details on how Perforce handles removal of files in the depot.
WARNING: The specified file is removed from the client workspace immediately. |
P4 Edit |
You need to use this command before editing a file. Write permission is turned on after using this command. |
P4 Revert changes |
Reverts any changes you have made to this file. |
You can edit the generated tools in the External Tools section of the Preferences Dialog.
Please note that your old settings are overwritten if you choose to configure Perforce using this wizard again.
BitKeeper is a commercial version control system available from BitMover, Inc. CodeGuide requires BitKeeper repositories to be in checkout:edit or checkout:get mode.
After choosing BitKeeper you have to specify the client executable which is normally named bk (Linux/Solaris/Mac OS X) or bk.exe (Windows).
In the next step you have to specify the repository directory.
After pressing Finish the wizard configures several tools with which you can control BitKeeper.
Checkin tool |
Runs the Checkin tool which is the preferred way of committing changes. |
Revision tool |
Shows the revision tree of the repository. |
Changeset tool |
Shows the last committed changeset. |
Pull from parent |
Pulls changes from the parent repository. |
Push to parent |
Pushes changes to the parent repository. |
Show history |
Shows the revision history of the repository. |
Commit changes |
Groups all pending changes to a changeset and commits this changeset. |
Check in |
Checks in changes made to the specified file. Please note that the changes are not grouped into changeset until either Commit changes or Checkin tool is invoked. |
Add to repository |
Add the file to the repository. This change is not grouped into a changeset until either Commit changes or Checkin tool is invoked. |
Delete |
Deletes the specified file from the repository. This change is not grouped into a changeset until either Commit changes or Checkin tool is invoked.
Please note that the file is not really removed from the repository. You can use bk unrm to resurrect a deleted file. |
Revision summary |
Shows the revision history of the specified file. |
You can edit the generated tools in the External Tools section of the Preferences Dialog.
Please note that your old settings are overwritten if you choose to configure Perforce using this wizard again.