BorCVS Readme

Introduction

BorCVS is a plugin for Borland C++ Builder and Delphi that provides access to CVS commands. CVS is the Concurrent Versions System, an open source revision control system. BorCVS is written using the Borland OpenToolsAPI and is integrated directly into the C++ Builder or Delphi IDE.

It was created by Thomas Bleier, thomas@bleier.at. The Pascal-Port was created by Per-Eric Larsson.

The current version is V 0.4, which is considered to be in ALPHA state.

The latest version can always be found at http://borcvs.sourceforge.net/.

Compatibility

Currently, BorCVS supports (and requires) the following software:

C++ Builder 5 Update Pack 1 recommended
Delphi 5 Update Pack 1 recommended
C++ Builder 6 supported by the latest CVS version and by the Pascal port
Delphi 6
Delphi 7 only supported by the Pascal port
CVS 1.11.1 or higher, CVSNT (www.cvsnt.org) recommended. The required CVS binary is included in the installation archive.
Windows

NT 4 or higher (2000, XP)

I did not test the plugin on Windows 9x (95, 98, ME), because I don't think these operating systems are suitable for development. If anybody want's to test them, tell me.

Important: before using this plugin, ensure that all your forms (.DFM files) are saved in text format. CVS does not handle binary files very well. If you don't do that, you won't be able to use this plugin correctly, since it assumes that .DFM files are in text format. You can convert existing .DFM files using the convert utility found the C++ Builder or Delphi \bin directory.

Because of this the plugin will not work with C++ Builder 4 or older or Delphi 4 or older. Of course it would be possible to handle forms (.DFM) as binary files, but I don't think that is very usefull. If anybody does not agree and want's to test the plugin on older versions (and eventuall modify it to work with that versions...), mail me.

Installation

The binary version of BorCVS is installed by executing the installer archive. It uses Microsoft Windows Installer for installation.

You can install or remove the plugin from the various development environments later by using the setup.exe program found in the BorCVS folder.

It is also possible to install it manually. At first the BorCVS.dll file should be copied to some directory. Then, a CVS binary is required. The installer contains CVS NT 1.11.1, but if you have already installed one, you should be able to use that. However, it is recommended to use the CVS binary that comes with BorCVS. Just enter the path in the preferences dialog. The final step is to register the plugin in the Borland IDE, which is done by adding a key to the registry. Either use the accompanied application (setup.exe) or use a registry editor, go to the key Software\Borland\_IDE_\5.0\Experts (where _IDE_ is C++Builder or Delphi) and add a string value named BorCVS. The value of that item should be the full path to the BorCVS.dll file. If you use Delphi and if C++ Builder is not installed on that machine, you also need the DLL CC3250MT.DLL. It is copied to the system directory by the installer.

At the next start the IDE should show a new menu item called "CVS", which contains the BorCVS commands.

If you already have a previous version of BorCVS installed on your system, it is recommended to remove it before installation of this new version.

Usage

See Manual.html

Bugs

This software is currently in ALPHA state. That means it is not ready for production use because it has not undergone enough testing. However, it works ok for me and therefore I decided to release it. You are invited to test the software and help to make it better. Please report bugs to thomas@bleier.at.

Currently known bugs are listed in the BorCVS bug database on Sourceforge

Version history

0.4 5 Apr 2002 The files frame (used in some dialogs, e.g. status, update, commit) has extended functionality and allows to execute the log, diff, update and commit commands directly
The result form is shown while the CVS command is executed, so the output is shown immediately
The cvsroot frame (used in the checkout and new module dialogs) is now much more flexible
BorCVS now saves the dialog settings in the registry
The default setting in the commit dialog is now to let the user select the files to commit
The "checkout" command is now always enabled
The "new module" command can now import other directories that the current project
Plus some cosmetic changes and bug fixes...
0.3 29 Nov 2001 First public release on sourceforge
Fixed some bugs
Added working-directory to CVS command
Added option to distinguish between cvsnt and other cvs
0.2   Fixed some bugs ;-)
All dialogs which show a list of files now also show the CVS status of the files
You can now select the files for commit/update even if working on the whole project
If available, a project-group is used for file reference
Forms are now "scaled" and should look better with different resolutions
When adding files, the case of the file names is preserved
When using pserver, cvs 1.11.1 should accept the password in the CVSROOT string now
The package contains cvsnt 1.11.1.1 now
0.1   First Alpha release

Credits

Thanks to the following persons for helping me to improve BorCVS (in no particular order): Per-Eric Larsson, Sven Hauptmann, Brent Digby, Ramene Anthony, Lucian Wischik, Tero Ripattila, Pete Fraser, Chris Means.

If I forgot to mention you, please contact me.

License

BorCVS is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, Version 2, as published by the Free Software Foundation.

BorCVS is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

A copy of the GNU General Public License is included in the distribution in the LICENSE.txt file; if not, it can be found at http://www.gnu.org/copyleft/gpl.html or write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.


Page created by Thomas Bleier, thomas@bleier.at, last modified 5-Apr-2002.