eclipse 2.0 cvs faq
frequently asked questions about the eclipse 2.0 cvs support

 
Eclipse Team Component

Last Modified: June 5, 2002


Table of contents:
Getting Started top
  1. How do I get a project into my workspace from CVS?

    1. Window->Show View->Other. Select CVS->CVS Repositories.
    2. Context Menu->New->Repository Location...
    3. Fill in the location information identifying your repository and click Finish.
    4. Expand the newly-created repository location.
    5. Expand HEAD.
    6. Find the module you are interested in.
    7. Context Menu->Check Out As Project.

    The project now exists in your workspace.

  2. How do I put a project into CVS from my workspace?

    1. Select the project in the Navigator or other view.
    2. Context Menu->Team->Share Project...
    3. Fill in the location information identifying your repository and click Finish.
    4. The Synchronize view opens, showing all your outgoing changes.
    5. Select the project in the Synchronize view.
    6. Context Menu->Commit.
    7. Answer yes when prompted to add new files to version control.
    8. Supply a release comment if you like.

    The project now exists in the repository.

  3. 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?

    1. Create a project in the workspace.
    2. File->Import, select File System, locate your files, click Finish.
    3. Select the project in the Navigator or other view.
    4. Context Menu->Team->Share Project...
    5. 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 top
  1. 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:

    1. Open the CVS Repositories view.
    2. Expand HEAD and select the project for which you want to configure tags.
    3. Context Menu->Configure Branches and Versions...
    4. In the "Browse files for tags" table, select one or more files that contain tags you would like to see.
    5. Click "Add Selected Tags".
    6. 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...".

Server Setup top
  1. What server versions of CVS are supported by Eclipse?

    Eclipse supports CVS version 1.11.1p1 or higher, running on a Linux or UNIX server. Eclipse does not officially support running CVSNT on a Windows server, but varied degrees of success have been achieved. In this case, CVSNT version 1.11.1.1 or higher must be used.

  2. Where can I get CVS for UNIX or Windows?

    CVS for UNIX can be downloaded from http://www.cvshome.org. CVSNT can be downloaded from http://www.cvsnt.org.

  3. Where can I find documentation on CVS?

    The CVS manual can be browsed online at http://www.cvshome.org/docs/manual/. The CVS FAQ-O-Matic can be found at http://ccvs.cvshome.org/fom/fom.cgi.

  4. I'm having problems running CVSNT 1.11.1.1 on Windows 2000, what's wrong?

    We have reports that CVSNT 1.11.1.1 (and perhaps later versions) will not run on Windows 2000 unless Service Pack 2 or later is installed.


Using SSH with CVS top
  1. 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:

    1. Specify "ext" as the connection method type when creating the repository connection.
    2. 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.
    3. Ensure that you can log on to the server using the external SSH tool without specifying a password.
  2. 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, the server must be running an SSH server with SSH1 protocol compatibility. If extssh does not work, it is likely 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.

  3. How do I set up public-key authentication?

    The steps for setting up public-key authentication vary depending on your SSH client. However, they all follow this set of common steps:

    1. 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.
    2. Copy the public key to the server. This is often done by pasting the public key into the file /home/user/.ssh/authorized_keys.
  4. 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.


Upgrading from Eclipse 1.0 top
  1. I'm using a workspace from 1.0. Why does the Team menu only contain "Share Project"?

    Team support changed drastically between Eclipse 1.0 and 2.0. As such, the method of sharing projects with the repository changed as well. We have tried to make it relatively easy for you to migrate, however. You will notice that your previously shared projects only have "Share Project" in the Team menu. If you select that option, a wizard will guide you through the migration process. When you are finished, your project will be shared and the Synchronize view will open. You will see conflicting changes on every file - this is due to changes in the way sync information is stored between 1.0 and 2.0. Pull down the triangle menu in the Synchronize view and select "Compare File Contents". After some work, the Synchronize view will show you only the files which are actually different.

  2. Eclipse 1.0 created all my files as binary in the repository. How do I fix this?

    Any file checked into a CVS repository from Eclipse 1.0 was marked as binary. This means that end-of-line conversions will not occur on checkout, and some features of CVS (such as auto-mergeable conflicts) will not apply to these files. As such, it may be desirable to change some of these files from binary to text. To change the file types, do the following:

    1. Make sure that all members of your team have saved and committed any changes to the affected files.
    2. Select the resources you wish to change in the Navigator or other view.
    3. Context Menu->Team->Set Keyword Substitution...
    4. Select "Automatic" to use the recommended detection. Click Next.
    5. Select the checkbox labelled "Include files that are already in the repository". Click Next.
    6. Click Finish. All affected files will immediately be modified in the repository.
    7. All other team members must now check out fresh copies of all affected files.
  3. Is a Branch the same as a Stream? What about other 1.0 terminology?

    In an effort to move away from generic terminology that applies to all repository providers, and toward provider-specific terminologies and workflows, many terms, menu items and labels have changed in 2.0. Here is a brief list of some of the changes. For more detailed information, please see the Eclise CVS documentation.

    Eclipse 1.0Eclipse 2.0Comments
    StreamBranchThe CVS terminology "Branch" replaces "Stream"
    CatchupUpdate"Update" refers to the standard CVS method of retrieving remote contents. For more details on Update, see the Eclipse CVS documentation.
    ReleaseCommitThese terms are equivalent.
    Add to WorkspaceCheck Out as ProjectThe CVS terminology "Check Out" replaces "Add to Workspace".
    NoneTagIn CVS, a Tag refers to either a Branch Tag or a Version Tag. Branches and versions together are referred to as Tags.
  4. I get a message saying the .vcm_meta file is obsolete and should be deleted. Should I really delete it?

    In Eclipse 1.0, meta-information about a project was stored in .vcm_meta. In Eclipse 2.0, this mechanism was made more general and the data was moved to the .project file. As such, the .vcm_meta file is now unneeded. The Eclipse CVS client will warn you of this state by placing a warning in the task list. If you still have people on your team who are using Eclipse 1.0 for development with your repository, then you should not delete the .vcm_meta file. If all members of your team are using Eclipse 2.0, then you can safely delete the .vcm_meta file and commit the deletion to the repository.


Using Eclipse and CVS for Java Development top
  1. 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.

  2. 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. The 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.

    Source folders must always begin beneath the project, not above it. See the Eclipse Java Development Tools documentation for more information on source folders.


Compatibility Between CVS Command-line Client and Eclipse top
  1. 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.

  2. 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.

  3. 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 on an Eclipse workspace. 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.


Working with Patches top
  1. How do I send someone a patch?

    If you have modified a project that you checked out from CVS, you may want to send those changes to someone else. This often occurs when you do not have commit rights, but want to send the changes to someone who does. To create a patch file:

    1. Select the changed project in the Navigator or other view.
    2. Context Menu->Team->Create Patch...
    3. Select a location for the patch.
    4. Use E-mail or other delivery method to send the patch to someone else.
  2. How do I apply a patch that someone sent me?

    To apply a patch, such as one generated in the previous step, do the following:

    1. Select the changed project in the Navigator or other view.
    2. Context Menu->Compare With->Patch...
    3. Fill in the location of the patch file
    4. Click Next. A summary of changed files will appear.
    5. Click Finish. The changes are now merged into the workspace.
    6. Context Menu->Team->Synchronize. You may now commit the changes into the repository.

Miscellaneous top
  1. What is the .project file, and should I release it to CVS?

    The .project file is created and maintained by Eclipse. It stores meta-information about the project, such as which projects it references and what type of project it is. If other members of your team will be using Eclipse to check out this project from CVS, you almost certainly want to release the .project file to CVS. Even if other members of your team are not using Eclipse, you may still want to release the .project file so that the information is persisted for you.

  2. I don't have update access to the CVS repository. Can I still check out a project with Eclipse?

    In some circumstances, depending on permissions on the server, you may not be able to browse the repository in the CVS Repositories view. In this case, it may still be possible to check out the project you want.

    1. Create an empty project.
    2. Context Menu->Team->Share Project...
    3. Enter the repository information and click Finish
    4. The Synchronize view appears. Update all incoming changes.

    The project in your workspace is now shared with the CVS repository, and contains the remote contents.