- 1 Getting Started
- 2 Browsing the Repository
- 3 Server Issues
- 3.1 What server versions of CVS are supported by Eclipse?
- 3.2 Why doesn't Eclipse 2.1.x work with CVS server versions 1.11.7 and beyond?
- 3.3 Why aren't older (pre 2.0.58d) CVSNT versions supported?
- 3.4 Where can I get CVS for UNIX or Windows?
- 3.5 Where can I find documentation on CVS?
- 3.6 When I perform a Replace With or Update operation, Eclipse tells me that option -C is not supported. What's wrong?
- 3.7 I performed a Replace With or Override and Update and one of the files involved ended up with strange characters in it. Why?
- 3.8 I got a "received broken pipe signal" error. What does it mean?
- 3.9 How do I use a local connection with Eclipse?
- 3.10 With CVSNT, why do I get the error: "Error fetching file revisions"?
- 3.11 Why can't I get Eclipse to work with CVSNT and mapped network drives?
- 3.12 Using CVSNT, Why do I get the error "cvs [server aborted]: cannot find .: No such file or directory"?
- 3.13 Why do I get the error "Resource <name> is not a child of folder <folder>"?
- 3.14 Why can't I set the keyword substitution mode for CVSNT using Eclipse?
- 4 Using SSH with CVS
- 4.1 How do I use SSH to communicate with the server?
- 4.2 What is the difference between ext and extssh?
- 4.3 My SSH server only support SSH2 protocol and I'm using Eclipse 2.1.x
- 4.4 How do I set up public-key authentication for an external SSH client?
- 4.5 When I try to connect using SSH, it tells me "Could not chdir to home directory /home/user/myname". What did I do wrong?
- 4.6 I got an 'Unknown response' while trying to perform CVS browsing. What went wrong?
- 4.7 I can't get keys generated using Putty to work with Eclipse
- 4.8 Why do CVS extssh connections fail on Fedora Core 4
- 4.9 Why does CVS extssh prompt for my password even when it is saved?
- 5 Using Eclipse and CVS for Java Development
- 5.1 When I check out a Java project from the repository, how do I make Eclipse aware it is a Java project?
- 5.2 What is the .classpath file? Should I commit it to the repository?
- 5.3 In my CVS repository, there is a source directory in the repository root. How can I use this with Eclipse?
- 5.4 How do I check out a module definition as a Java project?
- 5.5 Why does the bin directory keep appearing in the Synchronize view?
- 5.6 I ignored the bin directory but it appears to be shared anyway. Why?
- 5.7 How do I use CVS keywords in Java templates?
- 5.8 I'm working with a virtual module defined in the CVSROOT/modules file. How do I commit the .project and/or .classpath file?
- 6 Compatibility Between CVS Command-line Client and Eclipse
- 6.1 Does Eclipse use [WinCVS|CVS command-line client] to talk to the server?
- 6.2 The command-line CVS client stores information in CVS folders. Does Eclipse do the same thing? If so, where are the folders?
- 6.3 Is Eclipse compatible with the command-line CVS client?
- 6.4 Can I import a project into Eclipse that was checked out using the command line?
- 6.5 Why does Eclipse corrupt my *.jar, *.zip, etc. files?
- 6.6 When I use the command-line CVS on my project, why do the CVS folders sometimes appear in the Navigator View?
- 6.7 When I use the command-line CVS on my project, why go I get "resource out of sync" errors?
How do I get a project into my workspace from CVS?
- Choose File > Import from the main menu
- Select CVS > Projects from CVS and click Next
- Click on Create a new repository location and click Next
- Fill in the location information identifying your repository and click Next.
- Click om the Use an existing module and select the project or projects you want to check out.
- Click Finish
How do I put a project into CVS from my workspace?
- Select the project in the Navigator or other view.
- From the context menu choose Team->Share Project...
- Fill in the location information identifying your repository and click Next.
- Click Finish and the Sharing wizard closes and the Commit wizard opens.
- Supply a release comment and click Finish to commit the project contents to the repository.
The project now exists in the repository.
I already have a project checked out from CVS with the command-line tool. How do I use it in Eclipse without having to check out the whole project again?
- Create a project in the workspace.
- File->Import, select File System, locate your files, click Finish.
- Select the project in the Navigator or other view.
- Context Menu->Team->Share Project...
- The wizard should tell you that it found all the necessary information. Click Finish.
Eclipse has now shared the project with the CVS repository.
Browsing the Repository
Why don't my branches and versions show up when I am browsing?
When you are browsing in the CVS Repositories view, you may expect to see branch and version tags which you have previously created. In CVS, such tags are stored on individual files rather than on projects or folders. Rather than scan every file in the repository, Eclipse only scans one well-known file, .project, which should exist in every Eclipse project. It is possible that you have other interesting tags that do not appear on .project but which you would like to show up in the CVS Repositories view.
To make these tags appear, do the following:
- Open the CVS Repositories view.
- Expand HEAD and select the project for which you want to configure tags.
- Context Menu->Configure Branches and Versions...
- In the "Browse files for tags" table, select one or more files that contain tags you would like to see.
- Click "Add Selected Tags".
- Click "OK".
The CVS Repositories view will now display the chosen tags under the Branches and Versions categories. In addition, these tags will show up in other tag-related operations, such as "Replace With->Branch or Version...".
Why do some modules defined in CVSROOT/modules appear empty in the CVS Repositories view?
Some modules are not expandable because their definition is complex and difficult to parse on the client. These modules can still be checked out properly using the Check Out menu item from the module's context menu.
When I expand HEAD in the CVS Repositories View, it is always empty even though I know the repository has contents. Whats wrong?
If you also see messages from the server like "-f server: ...", this indicates that your CVS server has not been configured properly. Here is the line as it should appear in the "/etc/inetd.conf" file (example from AIX but the problem has also been seen on Solaris):
cvspserver stream tcp nowait root /usr/bin/cvs cvs -f --allow-root=/usr/cvsroot pserver
The key is the 2nd copy of "cvs". The online cvs book at http://cvsbook.red-bean.com has it right (although I thought it was a typo so never tried it). Look for "The pserver access method is not working" section. Part of the reason I got this wrong is that the linux xinetd configuration does not duplicate the name of the program. At one point I just copied the fields from the linux config into the fields in the AIX inetd.conf file. Now that I know what to look for, the other entries in the inetd.conf file have the program name duplicated.
What server versions of CVS are supported by Eclipse?
In 3.0, Eclipse supports CVS version 1.11.1p1 or higher, running on a Linux or UNIX server and CVSNT 2.0.58d or later, when properly configured. Eclipse 2.1.2 and before does not work with CVS versions greater than 1.11.6. CVSNT versions prior to 2.0.58d are not supported but some versions have been reported to work with few problems. There are also cases where newer server versions are required for some functionality. For instance, incoming change sets in the synchronize view require CVS version 1.11.5 or beyond to work properly (see bug 81960)</p>
Why doesn't Eclipse 2.1.x work with CVS server versions 1.11.7 and beyond?
Most of the interesting Eclipse CVS functionality relies on the format of the messages and the change in format made in 1.11.7 breaks the parsing in Eclipse versions prior to 2.1.3. Most of the incompatibilities for 1.11.x were addressed in 2.1.3. See bugs 46655 and 49056 for patches and workarounds for previous versions of Eclipse or remaining incompatibilities. As for 1.12.x releases of CVS, Eclipse 2.1.x is not compatible with this server version. Eclipse 3.0 is compatible with 1.12.7 but future releases of CVS may cause similar breakages. In such cases, Team>Update and Team>Commit should still work but the more advanced work flows (e.g. synchronizing) may not be reliable.
Why aren't older (pre 2.0.58d) CVSNT versions supported?
The reason older CVSNT versions aren't supported is because traditionally its development effort had been smaller and has lagged behind that of CVS Linux, thus its quality tends to be of issue. That has changed as of version 2.0.58d which is now supported (when properly configured) on Eclipse 3.0 and beyond.
Where can I get CVS for UNIX or Windows?
Where can I find documentation on CVS?
The CVS manual can be found by going to http://ximbiot.com/cvs/.
When I perform a Replace With or Update operation, Eclipse tells me that option -C is not supported. What's wrong?
This error indicates that your server version is CVS 1.10 or before. The -C option was introduced in version 1.11.
I performed a Replace With or Override and Update and one of the files involved ended up with strange characters in it. Why?
This error indicates that your server version is CVS 1.11 which has a bug when replacing a locally dirty file. Go here to see the supported CVS versions.
I got a "received broken pipe signal" error. What does it mean?
Eclipse sometime performs multiple commands within a single connection to the server. This may cause problems with CVS server that are running server scripts in reponse to certain commands.
How do I use a local connection with Eclipse?
Eclipse does not support the use of the local connection method as this requires a CVS client that also includes the CVS server code in it. Command line cvs uses the same executable for the client and the server whereas Eclipse is a client only. Since the repository is on the same machine as the client, you should be able to use pserver.
With CVSNT, why do I get the error: "Error fetching file revisions"?
This problem has several causes. One is the use of a backslash (\) in the repository path instead of a slash (/). Another can be a mismatch in the case of the letters in the repository path. See bug 56635 for more details.
Why can't I get Eclipse to work with CVSNT and mapped network drives?
The problem is that CVSNT only supports using the local connection method with network drives and Eclipse does not support this connection method.
Using CVSNT, Why do I get the error "cvs [server aborted]: cannot find .: No such file or directory"?
I think the problem is that of user rights on the machine CVSNT is running on. You might try one or more of the following options:
- create a group having full access rights to the CVSNT
repository directory structure plus the temp folder CVSNT is using.
This is easiest if you specify a separate CVSNT temp directory such as
"c:\cvstemp" using the Advanced tab in the
CVSNT control panel. (The default temporary directories in "C:\WINNT\TEMP" and "C:\Documents and Settings" have access restrictions under Win2000 and WinXP).
- turn off impersonation in CVSNT
- add all CVS users to PowerUsers on the machine CVSNT is running on
Why do I get the error "Resource <name> is not a child of folder <folder>"?
CVSNT has a separate option called Emulate "-n checkout" bug that must be enabled for Eclipse to work properly. This is because the "bug" in question is the behavior of a 1.11.x server which Eclipse requires.
Why can't I set the keyword substitution mode for CVSNT using Eclipse?
CVSNT has a non-standard way of dealing with keyword substitution so you will need to use a CVSNT specific client to modify the keyword substitution mode.
Using SSH with CVS
How do I use SSH to communicate with the server?
The pserver protocol sends passwords over the network in plaintext. Many people prefer to establish a secure connection using SSH. Eclipse supports two methods of connecting to CVS repositories using SSH.
To use the Eclipse's built-in SSH support, simply specify "extssh" as the connection method type when creating the repository connection.
To use SSH support from an external tool, you must:
- Specify "ext" as the connection method type when creating the repository connection.
- Window->Preferences->Team->CVS->Ext Connection Method. On
this page, specify the name and location of your external ssh client.
(For example, "
C:\plink.exe" or "
/usr/local/bin/ssh"). Also specify the name and location of the CVS binary on the server. The default value is often correct.
- Ensure that you can log on to the server using the external SSH tool without specifying a password.
Note: In Eclipse 2.1, you can also specify (on the Ext Connection Method preference page) the parameters to be passed to the SSH client, including the password.
What is the difference between ext and extssh?
The extssh connection method uses a built-in SSH client. The ext connection method allows you to specify an external SSH client to use. For extssh to work with Eclipse 2.1.x and before, the server must be running an SSH server with SSH1 protocol compatibility. If extssh does not work, it is possible that the server is running only the SSH2 protocol. If this is the case, you must configure the ext connection method with an external SSH client. In Eclipse 3.0 and beyond, extssh does support SSH2.
My SSH server only support SSH2 protocol and I'm using Eclipse 2.1.x
Eclipse comes with a built-in SSH connection method called 'extssh'. Prior to Eclipse 3.0, this method only supported SSH1 servers. If your server is running SSH2 and you want to use Eclipse 2.1.x to connect to that server you have two options:
- use a command line SSH client that supports SSH2 with the 'ext' connection method
- download a plugin created by JCraft that provides a SSH2 connection method.
To use the 'ext' connection method, download and install an SSH command line
client for your operating environment. In the Team > CVS > Ext Connection
Method preference page, configure the location of the SSH executable and how
the executable is to be called. For the ext method to work the CVS client
on your server must support the server mode. You can verify this by running
cvs --help-commands and ensure that the server command is supported.
How do I set up public-key authentication for an external SSH client?
The steps for setting up public-key authentication vary depending on your SSH client. However, they all follow this set of common steps:
- Use the client program (or a utility that came with it) to generate a public/private key pair. This program might be called ssh-keygen or puttygen.exe.
- Copy the public key to the server. This is often done by pasting the
public key into the file
When I try to connect using SSH, it tells me "Could not chdir to home directory /home/user/myname". What did I do wrong?
This often happens when using SourceForge projects for the first time, but may occur on other servers as well. You must manually log in to the server, using an interactive SSH session, in order to create your home directory for the first time. After this, you will be able to log in successfully.
Use your SSH client to connect to the server (e.g. cvs.sourceforge.net) and log in with your username and password. Your home directory will be created for you.
I got an 'Unknown response' while trying to perform CVS browsing. What went wrong?
I can't get keys generated using Putty to work with Eclipse
Putty's private key is encrypted by AES, but JCE (Java Crtptgraphy Extension) included in J2SE 1.4.x does not support AES. So, at present time, there is no plan to support it. Of course, JSch (the SSH2 client used in Eclipse) may support Putty's key by using the latest J2SE in the near future, but Eclipse 3.0/3.1 will not be able to use it because they must run on J2SE 1.4.0. This is explained more in bug 84281.
Why do CVS extssh connections fail on Fedora Core 4
There is an issue with Sun's JDK 1.4.2 and Fedora Core 4 that causes extssh connections to fail with the message:
CVS Communication error: org.eclipse.team.internal.ccvs.ssh2.CVSSSH2ServerConnection$SSH2IOException: Invalid argument or cannot assign requested address
The issue seems to be related to both IPv6 and IPv4 being available in FC4. The solution is to add
with the -vmargs option when eclipse is started.
Why does CVS extssh prompt for my password even when it is saved?
This problem has been seen on servers that have a problems in a particular authentication method. This will cause extssh to believe that there has been an authentication failure which trigger a password prompt. See bug 119008 for details.
Using Eclipse and CVS for Java Development
When I check out a Java project from the repository, how do I make Eclipse aware it is a Java project?
Eclipse makes use of information in the .project file to determine if a project is a Java project. If the project you have checked out does not have a .project file, Eclipse will not mark it properly. If you use "Checkout As..." instead of "Checkout" in the Repositories view, then you will be given an opportunity to specify Java as the project type and provide Java specific configuration information.
What is the .classpath file? Should I commit it to the repository?
Eclipse's Java development tools create and maintain a special file, .classpath, in the root of each Java project. This file contains information about the project's classpath, including references to other projects, external jars, and the project's own source path. If you are working on a team with other developers that use Eclipse, you probably want to commit this file to the repository so that others can benefit from correct classpath settings. If the other developers on your team do not use Eclipse, you may still want to commit the .classpath file so that your settings are persisted - this should not affect the users that are not using Eclipse.
In my CVS repository, there is a source directory in the repository root. How can I use this with Eclipse?
If the name of the CVS module is part of the package name of Java files, you will encounter problems. For example, if the module you check out is called "test", and it contains a folder called "code" which contains Java files that claim to be in the package "test.code", Eclipse will not be able to compile these Java classes. There are several solutions to this problem:
- One solution is to move the top-level package folder ("test" in this case) to be a subfolder of the CVS module. In this case, create a folder called "test" in the project "test", and move "code" into it. Then commit your changes.
- Another possible solution is to use modules definitions.
Modules can be defined in the CVSROOT/modules file to include root
level projects as subfolders of the checked out folder stucture. The
steps to get this to work for the above example are:
- Add the following two lines to the CVSROOT/modules file
test &test MyProject &test
- In the CVS Repositories View, select the modules with the name matching the one defined in the CVSROOT/modules file (Note that in Eclipse 2.0.x, you will need to switch to "Show Modules" mode using the drop down menu in the title bar in order to see the module).
- Select "MyProject" and choose "Checkout Module" from the popup menu.
See the CVS documentation for more information on defining modules.
- Add the following two lines to the CVSROOT/modules file
- If you are using Eclipse 2.1, you can create a new Java Project and then perform a "Checkout Into..." on the CVS Module. This operation allows you to check out a CVS modules into an existing project as a subfolder and configures that target project to be shared with CVS.
Source folders must always begin beneath the project, not above it. See the Eclipse Java Development Tools documentation for more information on source folders.
How do I check out a module definition as a Java project?
To check out a module that is defined in the CVSROOT/modules file as a Java project, you may have to pre-create the target project as a java project in the workspace before performing the "Check Out".
Why does the bin directory keep appearing in the Synchronize view?
JDT marks most of its build output as being derived resources so that CVS and other repository types can easily ignore these resources from version control. However, if you define custom source and build output folders, the newly created build output folder will not be marked as derived. In many cases the root build output folder is named bin. To ignore this folder, select it in the navigator and choose Team > Add to .cvsignore, then commit the .cvsignore file to the repository so that the bin folder will be ignored at all times for that project.
If a resources whose name matches a pattern in the .cvsignore also exists in the repository, then this resource is not ignored. For the case of the bin folder, chances are that the bin folder was committed to the repository at some point. The solution is to purge this directory from the repository.
How do I use CVS keywords in Java templates?
Substitute the usual keyword (e.g. $Revision: 1.59 $) with the $ escaped version (e.g. $$Revision: 1.59 $$).
I'm working with a virtual module defined in the CVSROOT/modules file. How do I commit the .project and/or .classpath file?
The easiest way to address this problem is to create a project in the repository whose purpose is to hold the .project and .classpath files for your module. For example, if your module definition is my-module &sub-dir1 &sub-dir2 you could change it to my-module my-module-project &sub-dir1 $sub-dir2 where my-module-project is an new folder on the CVS server. Committing the .project and .classpath files would create the files in this folder.
Compatibility Between CVS Command-line Client and Eclipse
Does Eclipse use [WinCVS|CVS command-line client] to talk to the server?
No. Eclipse implements a CVS client in Java that talks directly to the server using the documented CVS protocol. No external CVS client is required.
The command-line CVS client stores information in CVS folders. Does Eclipse do the same thing? If so, where are the folders?
Eclipse stores CVS sync information in CVS/ folders in the same way as the command-line CVS client does. However, you rarely see these folders within Eclipse. They are marked using a Core facility called "team-private" which causes them to be hidden from view. If you open a (non-Eclipse) file explorer you will see that these directories and their contents appear on the file system.
Is Eclipse compatible with the command-line CVS client?
Eclipse Team CVS stores its meta information in a format that is compatible with the command-line CVS client. Thus you should be able to use a CVS command line client against Eclipse workspace files on disk. Please note that this support is experimental, and you may run into problems. However, we are very interested in making this work, so please report any bugs you find.
Whenever you use external tools to modify workspace files, you must perform a Refresh from within Eclipse to make the workspace aware of the changes.
You may encounter unexpected behaviour when using the command-line CVS client in conjunction with deleted folders. Eclipse's CVS support keeps track of deleted folders and their contents so that, on the next synchronization, the Synchronize view can properly report on the changes. This information is kept outside of the CVS meta folder structure. This is because in CVS you normally inform the repository of deletions prior to deleting them locally, which is a different workflow than we like to support in the Synchronization view. Thus it is recommended that you do not use the command-line CVS client while you have pending deletions to commit. In some circumstances it could cause the Synchronize view to display incorrect contents, although it should not cause any lost work.
Can I import a project into Eclipse that was checked out using the command line?
Yes you can. However, you may encounter errors from the builder related to the copying of the CVS folders. This can have two causes. The first is when the project is imported before the CVS plugin is loaded. To avoid this problem, make sure you open one of the CVS views before importing the project. The second is due to a "race" on import between the CVS plugin and other plugins that react to the import. If the CVS plugin wins the race, then the CVS folders are hidden but if another plugin discovers the CVS folders first, it may cause the workbench to "know" about them and perform inappropriate actions on them. The best way to solve the problem is to run a Team>Update on the project and then shutdown and restart Eclipse (although closing and reopening the view in which the CVS folders appear may work as well). If this fails, you may need to check the projects out from your repository using Eclipse instead of the command line client.
There is a plugin named org.eclipse.team.cvs.delta available on the [http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-vcm-home/dev.html Development Resources] page that loads on startup and ensures that CVS folders are properly hidden. If you import CVS projects often, you may want to use this plugin.
Why does Eclipse corrupt my *.jar, *.zip, etc. files?
This problem is caused by the keyword substitution mode assigned to the file on the server. Any binary files must be marked as -kb. The default for CVS is to mark unknown file types as text. CVS provides cvswrappers and the cvs admin command to set file types.
There are some cases where CVS folders are not hidden from the UI as the user would expect. For instance, CVS folders will appear if a user imports a CVS project into Eclipse before the CVS plug-in is loaded. To avoid this, open the CVS Repositories view (thus loading the CVS plug-in) before importing CVS projects into Eclipse. There is also a plugin available <a href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/platform-vcm-home/dev.html">here</a> that will ensure that the CVS folders are properly hidden even if the CVS plugin is not loaded.
When I use the command-line CVS on my project, why go I get "resource out of sync" errors?
This occurs when files that are resources in Eclipse are modified outside of Eclipse. One solution is to perform a refresh (available from a resource's popup menu) on any resources or projectsthat where modified outside of Eclipse. Another is to enable the Refresh Automatically preference on the General<Workspace preference page.