CWCVS 1.0
Contents.
Description.
CWCVS
is a version control plugin for Metrowerks
CodeWarrior which allows you to use Strata's
public domain MacCVS CVS client for source control without leaving the CodeWarrior
IDE.
CVS is a widely used POSIX-based source control system and CVS clients are
available on many platforms, including the Macintosh, making it a reasonable
choice for multiple platform development. CWCVS allows Macintosh developers
to use CVS with CodeWarrior without arcane command line arguments or scripts.
Return to the Contents.
Features.
CWCVS provides the standard functions of most source-code control systems:
- check-in
- check-out
- get-info
- add
- delete
- recursive-get
Return to the Contents.
Requirements.
CWCVS requires a version of CodeWarrior that supports the VCS plugin architecture,
that is a version greater than 1.7.4, which shipped with CW11. We strongly
recommend using CWPro if at all possible.
CWCVS also requires that you install a version of MacCVS on your machine.
MacCVS is a public domain implementation of a CVS client that is based on
the GNU implementation of CVS. We require the Strata
version 3.0 of MacCVS which can be downloaded
from the web. This version supports resource forks, an improved AppleEvent
suite and project files.
The current CodeWarrior VCS architecture does not support creation of databases,
therefore you must either use existing CVS repositories or know how to create
new CVS repositories on the server. Moreover, CWCVS does not have a cvs
checkout facility, so you must use the MacCVS application to create one
from an existing repository.
For those who wish to "roll their own" MacCVS from the public
domain source, CWCVS requires a local copy of an application with the creator
code 'mCVS' that implements the DoScript AppleEvent {'misc', 'dosc'} wi
the following parameters:
Do Command: Execute a CVS command
Do Command list -- Command line arguments, one per list item
[Mode AE/File] -- Mode (AE, File).
[Environment list] -- Environment variables.
[Filename string] -- Output file path.
[Pathway string] -- Starting pathway.
[NoLineBuffer boolean] -- if true, send each result line as separate AE.
Note that this is slightly different from the original event defined by
Mike Ladwig in that the arguments are no longer parsed from the list strings,
but copied directly. The keyword definitions are:
The environment variables are specified as pairs of adjacent entries in
a list, namely <name> <value> <name> <vaue>... .
Return to the Contents.
Installation.
Simply copy the CWCVS folder into the CodeWarrior Plugins folder in your
CodeWarrior hierarchy. CodeWarrior should not be running when you do this.
If you do not have a copy of CWCVS, you can download
it from our web site. There is also a FAQ
if you have questions that are not covered by this manual, and some release
notes describing the version change history.
Return to the Contents.
Preparation.
Before using CWCVS with a project, you must first have a CVS repository
that is available to you via TCP. How to do this is described in the cvs(1)
man pages on your POSIX repository system.
Next, you need to have a project folder created by the cvs checkout command.
We strongly recommend that you do the initial checkout with the version
of MacCVS that you will use with the plugin. We have found that diferent
versions of MacCVS have slightly different file formats which are mutually
incompatible.
If you are using the recommended version of MacCVS, you can check in project
files by using the .mcp extension, so you may wish to rename your project
files.
Return to the Contents.
Configuration.
To configure a project for use with CWCVS, do the following:
- Determine the setting of the $CVSROOT environment variable for the
CVS repository that you wish to use;
- Open the project file for which you wish to use CWCVS for source control;
- Choose Version Control Settings... from the Edit menu;
- Select the"VCS Setup" panel;
- Make sure that "Use version Control" is checked;
- Choose "CWCVS" from the popup menu;
- Enter your CVS username (e.g. "hawkfish") in the "Username"
field (this is the $
LOGNAME and $USER environment
variables);
- Enter your CVS password (this is the
$CVS_PASSWORD environment
variable);
- Use the "Local Root" control to choose the CVS checkout
folder;
- Use the "Database Path" control to choose any folder: as
CVS does not use a file system database, we suggest choosing the "Local
Root" folder, but you must choose a folder or the IDE will not enable
source control;
- Set the other options as desired (we recommend "Connect on open",
"Remember password" and"Try to mount shared volume"
to minimize startup interaction);
- Click "Save".
- Select the "VCS Environment" panel;
- Click on the list entry containing the line
"CVSROOT=...";
- Edit the value of the
CVSROOT environment variable;
- Click "Add";
- Enter any other environment variables by entering the name and the
value and clicking "Add". Note that tab does not work between
the fields (this is an IDE bug);
- Click "Save".
Important Note:
CVS maintains the "Local Root" directory specified above. It is
good practice to consider this directory as owned by CVS.
Return to the Contents.
Commands.
CWCVS supports the following commands in the IDE menu:
CWCVS does not (yet) support the advanced versions of any commands.
All cvs commands use the directory of the file being manipulated as the
cwd, or the local root directory for Recursive commands.
Kerberos.
CWCVS attempts to make life pleasant for Kerberos users. Before each command,
$CVSROOT is checked to see if the ":kserver:" string is present.
If it is and if there is no valid ticket in the cache, the login dialog
is put up. Users who use Kerberos without the :kserver: option must login
seperately.
Return to the Contents.
Get.
The Get command retrieves the current version of the file. The recursive
version updates all files in the project folder to their current versions.
All files are locked by default.
The actual CVS commands are:
cvs -r update <file>
for the file version and:
cvs -r update <local root>
for the recursive version.
Return to the Commands.
Checkout.
The Checkout command retrieves the latest version of the file from
the database and makes it available for writing. This consists of updating
the file with write permission.
The actual CVS command used is:
cvs -w update <file>
Return to the Commands.
Checkin.
The Checkin command commits the current version of a file to the
repository and locks it. The recursive version commits all locally modified
files except for CodeWarrior project files. Project files must
be checked in non-recursively.You will be prompted for a comment that describes
what you are did to the file(s). After checkin, the file will be locked.
The actual CVS commands are:
cvs -r commit -m <comment> <file>
for the file version and:
cvs -r commit -R -m <comment>
for the recursive version.
Return to the Commands.
Undo Checkout.
The Undo checkout command cancels the checkout of the file. It does
this by deleting the file and getting a fresh copy.
The actual CVS command used is:
cvs -r update <file>
Return to the Commands.
History.
The History command displays a change history of the file obtained
from CVS. If you select multiple files, each one will appear in its own
window with a ".history" suffix.
The actual CVS command used is:
cvs log <file>
Return to the Commands.
Status.
The Status command displays the current state of the file, including
the revision numbers and tags. If you select multiple files, each one will
appear in its own window with a ".status" suffix.
The actual CVS command used is:
cvs status <filename>
Return to the Commands.
Difference.
The Difference command allows you to compare a file to the repository
version. If you select multiple files, each one will appear in its own window
with a ".diff" suffix.
The actual CVS command used is:
cvs diff -c <file>
Return to the Commands.
Label.
The Label command allows you to label the state of a module so that
you can refer to it later. The command will prompt you for a label to use
for the module. You can then use the cvs command line to retrive all file
versions with this label. Future versions of CWCVS will use the Recursive
Get command to retrieve tagged file sets.
The actual CVS command used is:
cvs tag -F <tag>
Return to the Commands.
Rename.
The Rename command changes a file's name in the repository. It does
this in the recommended manner, namely by renaming the file locally, deleting
the old file and adding the new file. After the rename, the file is labeled
as checked out and can now be checked in. The IDE does not know that the
file has been renamed, so you must add the new version manually before doing
the checkin.
The actual CVS/POSIX commands used are:
mv <old name> <new name>
cvs remove <old name>
cvs add <new name>
Return to the Commands.
Add.
The Add command adds a new file to the local repository. It does
not commit it. After the add command, the file is labeled as checked out
and can now be checked in.
The actual CVS command used is:
cvs add <file>
Return to the Commands.
Delete.
The Delete command schedules a file to be deleted from the respository.
It does not commit the deletion.
Unlike CVS, the IDE expects the file to only be deleted from the repository
but not from the local drive, which means that once the file has been deleted,
the only way to commit the deletion is to use the Recursive
Checkin command.
After commiting, the file is still in the repository attic, but the IDE
has no interface for recovering it.
The actual CVS command used is:
cvs remove <file>
Return to the Commands.
Connect.
The Connect command makes sure that MacCVS is available and fails
if it is not.
Return to the Commands.
Disconnect.
The Disconnect command is currently a nop.
Return to the Commands.
About.
The About command displays a dialog box with version information.
Return to the Commands.
Variables.
The Variables command displays information about the project, including
the status of all the files.
The actual CVS command used is:
cvs status
Return to the Commands.
Disclaimer.
This software should do what is described in this document. If it doesn't,
you can simply stop using it. If you pay for it, and within a year find
that it doesn't do what is described here, then you can notify us and we
will refund your money and cancel your license.
Electric Fish, Inc. hereby disclaims all warranties relating to this software,
whether express or implied, including without limitation any implied warranties
of merchantability or fitness for a particular purpose. Electric Fish, Inc.
will not be liable for any special, incidental, consequential, indirect
or similar damages due to loss of data or any other reason, even if Electric
Fish, Inc. or its agent has been advised of the possibility of such damages.
In no event shall Electric Fish, Inc. be liable for any damages, regardless
of the form of the claim. The person using the software bears all risk as
to the quality and performance of the software.
Kerberos
This code contains calls to the MIT KClient library for authentication only.
Such use is not prohibited for export by US law. Because of this, we are
required by MIT to include the following notice from them regarding the
KClient code:
Copyright (C) 1989 by the Massachusetts Institute of Technology
Export of this software from the United States of America is assumed
to require a specific license from the United States Government.
It is the responsibility of any person or organization contemplating
export to obtain such a license before exporting.
WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
distribute this software and its documentation for any purpose and
without fee is hereby granted, provided that the above copyright
notice appear in all copies and that both that copyright notice and
this permission notice appear in supporting documentation, and that
the name of M.I.T. not be used in advertising or publicity pertaining
to distribution of the software without specific, written prior
permission. M.I.T. makes no representations about the suitability of
this software for any purpose. It is provided "as is" without
express
or implied warranty.
US Government:
Government End Users: If you are acquiring the Software and fonts on behalf
of any unit or agency of the United States Government, the following provisions
apply. The Government agrees:
- (i) if the Software and fonts are supplied to the Department of Defense
(DoD), the Software and fonts are classified as "Commercial Computer
Software" and the Government is acquiring only "restricted rights"
in the Software, its documentation and fonts as that term is defined in
Clause 252.227-7013(c)(1) of the DFARS; and
- (ii) if the Software and fonts are supplied to any unit or agency
of the United States Government other than DoD, the Government's rights
in the Software, its documentation and fonts will be as defined in Clause
52.227-19(c)(2) of the FAR or, in the case of NASA, in Clause 18-52.227-86(d)
of the NASA Supplement to the FAR.
Return to the Contents.
For more information, contact us at hawkfish@electricfish.com..
Copyright© 1997-8 by Electric Fish ,Inc. All rights reserved.