Working with CVS in Eclipse

Transcription

1 Working with CVS in Eclipse Hoang Huu Hanh Institute of Software Technology and Interactive Systems Vienna University of Technology Favoritenstrasse 9-11/ Vienna, Austria Table of Contents I. CVS Basics... 1 II. Create a New Repository Location... 2 III. Putting a Project onto CVS... 3 IV. Pulling a Project from a CVS Repository... 7 V. Team Working VI. References Appendix: List of Figures I. CVS Basics [1] CVS (Concurrent Versions System) is the leading open source versioning system. CVS manages files by noting changes in them. Every change is tagged with a timestamp and the user id. A comment lets the user communicate the reason for the change. The information is saved in a so called repository (directory tree on the hard drive, managed by the CVS server). The data is always put in a branch of the repository (the main branch is named HEAD). Each change will be given a unique revision number. New files start with 1.1. You can compare or replace files with ones of another revision number any time. If the resources in your project (consisting of files of possibly different revision numbers) have a state that seems worthy to be saved explicitly you can create a version. A version is a set of files with certain revision numbers. If a developer wants to share his changes there is possibly a conflict with changes of another developer (if they affect the same resource - no locking with CVS!). It is the responsibility of the developer seeing the conflict to merge the changes and then try again. The merge will be done locally; you cannot accidentally put the current revision of a file in an inconsistent state. If different paths of development should be followed concurrently (bug fixes, internationalization etc.) the developers can put their changes into different branches of the repository. If there are different paths come together then a merge will be needed. Note: This tutorial has been tested with Eclipse version 3.0 Build of 18

2 II. Create a New Repository Location In order to create a new repository location in Eclipse: 1. Open perspective CVS Repository Exploring : choose command Window Open Perspective CVS Repository Exploring. If there is not this command under Open Perspective, you can choose Other option instead of. Then, you could choose CVS Repository Exploring command in the dialog appearing as Figure 1. Window of CVS Repository Exploring is shown as Figure 2. Figure 1: Choose CVS Repository Exploring Figure 2: CVS Repositories 2. Right click on this perspective to bring the short-cut (context) menu out, then choose New Repository Location (see Figure 3); or simply click the button on this perspective. Figure 3: Create new repository location 3. After that, fill parameters for the new repository location in following dialog (Figure 4) 4. Click Finish button to complete the procedure. If there is no error, a repository location is created and listed in the same perspective window. 2 of 18

3 Host: address of CVS server Repository path: CVSROOT path Connection Type: extssh should be chosen. Figure 4: Enter parameters for new repository III. Putting a Project onto CVS This section describes the way to put (or import / check-in) an existing project in Eclipse onto CVS for group working. The steps are as follow: 1. Create a new project or Open a project. 2. Select option Share Project under Project menu as Figure 5: Figure 5: Sharing a project 3. This selection would bring you with a dialog to choose an existing repository location or create a new repository location (see Figure 6): 3 of 18

4 List of existing repository locations Figure 6: choose a repository location 4. If you choose to create a new repository location, you should fill necessary information in the following box as the Figure 7: Host: address of CVS server Repository path: CVSROOT path Connection Type: extssh should be chosen. Figure 7: Creating a new repository location 5. Next step: name for your new module on CVS. There are three options as described in Figure 8 4 of 18

5 Figure 8: Module naming 6. After going through above steps, Eclipse uses your parameters to access CVS server and put your project onto. Figure 9: Accessing CVS server and processing the project 5 of 18

6 During this session, if there is any problem, Eclipse would inform you and interrupt the session. (In my case, no problems appear ). 7. After that, a dialog would appear to ask you checking something. Then, you just click Finish button to start putting onto CVS repository. Figure 10: Confirm dialog 8. After press Finish button, Eclipse would ask you to commit all new changes in the project into CVS repository Figure 11: Ask for committing changes There are two options now: if you choose Yes, you would be prompted to give a commit comment (Figure 12); after that changes would be committed to the CVS repository and a version control would be added to. Figure 12: Enter a commit comment 6 of 18

7 Otherwise, if you choose No, you can commit changes later using command Commit under Team option (mentioned in Section V.2). In addition, you could add resources of the projects to Version Control by choosing command Add to Version Control in context menu Team. The Versioning will be mentioned in Section V. 9. Finally, if you choose Yes in above step, a window displaying transactions would appear as below: Figure 13: Transactions A project in the mode of CVS working looks like follow (Figure 14) Addess of CVS Server Figure 14: CVS working mode of "HelloWorld" project IV. Pulling a Project from a CVS Repository This section illustrates how to pull a project from a CVS repository. In CVS-terms, it is called checkout process. With Eclipse, it seems to be easy. Let s do as following steps: 1. Choose to create a new project in Eclipse; a dialog would appear (Figure 15). Figure 15: Creating checkout projects from CVS 7 of 18

8 2. Expand CVS item and choose the only one sub-item Checkout Projects from CVS. 3. Choose or create a new CVS repository location (the same as I.3). Figure 16: Choose a repository location to check out 4. Select module to check out: there are two options at this stage. You can type the module name if you remember in box goes after Use specified module name as Figure 17: Figure 17: Using specified module name Or you can browse CVS repository to choose an existing module (recommended). List of existing modules in CVS repository Figure 18: Browsing to choose module in the repository 8 of 18

9 5. After choosing the module, click Next to go to next step: checking some meta information of project in CVS and ask user to name the new checkout project. Figure 19: Naming for new checkout project 6. Next step is to choose workspace location to store the new project. Figure 20: Choose workspace location 7. and choose the tag to checkout (HEAD should be chosen). Finally, click Finish to start checking out the project. Figure 21: Select tag to checkout 8. Finally, click Finish to start checking out the project. 9 of 18

10 Figure 22: Transaction window New checkout project looks like as below: Figure 23: New checkout project V. Team Working Almost commands supporting team working in Eclipse with CVS are under shortcut menu Team. In order to bring the shortcut menu, you click right mouse button on the project package, and point mouse to Team item; and then select appropriate commands. 1. Synchronizing Synchronize with Repository : this feature helps developers to synchronize theirs local resource with the base resource on CVS repository and remote resource variants as well. When this feature is called, a comparison would be made. New CVS systems support for three-way comparison feature. This type of comparison involves the local resource, a remote resource variant and a base resource variant. Three-way comparison consists: o Outgoing Change/Deletion/ Addition o Incoming Change/Deletion/ Addition o Conflicting Change/Deletion/Addition The first events are for the changes should be committed to CVS repository. The second ones are the changes should be applied for your local resource. In the last ones would happen when more than two developers are editing one file. In this case, the base resource variant represents a common ancestor for the local and remote resources. Figure 24 shows the widgets in Synchronize perspective helping developers to see the different events after synchronizing. 10 of 18

11 Show incoming events Show conflicting events Show outgoing events Show incoming/outgoing events Figure 24: Showing kinds of changing events In Figure 25, there are some changes in file HelloWorld.java which need to be committed to the repository. Figure 25: Synchronize with Repository Number of incoming, outgoing or conflicting changes would be displayed in the status bar of this perspective window with arrows blue, grey and red. 2. Seeing Differences After synchronizing, changes (if any) would appear in Synchronize perspective. In order to see the differences between local resources and CVS repository, you just double click on the resource and see the differences. You also can see the differences by choosing command Compare with Latest from HEAD Another Branch or Version In this window (Figure 26), you can see the Common Ancestor (mention above) and make two-way or three-way comparison. 11 of 18

12 Figure 26: See differences 3. Committing and Updating Commit : commit changes from local resource to a CVS repository. Signs > appeared in front of some resources say that they should be committed to the CVS repository (see Figure 27). Let s run command Commit..., you would be prompted to enter a commit comment (see Figure 12). After entering the comment, you press OK and changes would be committed to CVS repository. The progress window of this command would be Figure 28. Figure 27: Signs ">" in project window Figure 28: Committing changes 12 of 18

13 Update : update values of tags which could be chosen. You choose command Update... and choose tags to be updated in a dialog (Figure 29). After choosing the tags, press Finish to update them. Figure 29: Choose tags for updating Restore from Repository: to restore deleted files from CVS repository. Disconnect: terminate CVS working mode. The project becomes local. 4. Working with CVS Revisions Revisions are created when you commit changes with comments to CVS repository. To show revisions of a resource, you run command Team Show in Resource History of the resources context menu. Revisions Viewing The view CVS Resource History shows up. It lists the revisions of the chosen resource Figure 30: CVS Resource History The currently used revision is marked with '*' 13 of 18

14 Replacing the current vision with another one You choose Get Sticky Revision of the revision that will replace the current revision. A warning notice would appear, then you choose to press OK to replace the current revision with chosen revision. 5. Working with CVS Versions Versioning a project 1. Choose the project you want to version in CVS Repositories view from HEAD tag. 2. Choose command Tag as Version of the project context menu, then you would be prompted to enter a version tag, e.g. Alpha1 as Figure 31, and press OK. Figure 31: Enter a version tag Tagging process would be appeared like following figure Figure 32: Tagging You also can version projects from the workspace by running command Tag as version in the Team context menu of a chosen project. Checking out a Version 1. Select the version you want to load from CVS repository in CVS Repositories perspective. (CVS Repositories: Versions - <project name> - <version name>) 2. Bring the context menu out; choose command Check Out As (see Figure 33) 3. A dialog (Figure 19) would be appeared to prompt you enter a new name for the checkout project. You can choose one of options of naming for the project and follow the guide of the wizard in order to complete of checking out a project from a version in CVS repository. 14 of 18

15 Figure 33: Checkout from a version 6. Working with Branches Creating a branch 1. Run command Team Branch 2. Enter a name for the new branch and a version Figure 34: Creating a new CVS branch 3. Click OK to finish and the branching is started Figure 35: Branching in progress 15 of 18

16 Merging 1. Run command Team Merge 2. Select the version created when you branched and press Next Figure 36: Select the merge start point 3. Select the version or branch you want to merge Figure 37: Select the version or branch to merge 4. and press Finish. The merging is started as follow Figure 38: Merging 16 of 18

17 Comparing You can make comparisons between your current version (branch) and another version or branch by: 1. using command Compare With Another Branch or Version in the context menu. 2. Choose version or branch to make comparison with Figure 39: Comparing with another version 3. Click OK to proceed. The results of the comparison would display in Synchronize perspective. VI. References [1] 3plus4 Software. Available at: [2] Derek Clifford, Configuration Management with CVS and Open Source Tools, GNU Free Documentation ======================== 17 of 18

18 Appendix: List of Figures Figure 1: Choose CVS Repository Exploring... 2 Figure 2: CVS Repositories... 2 Figure 3: Create new repository location... 2 Figure 4: Enter parameters for new repository... 3 Figure 5: Sharing a project... 3 Figure 6: choose a repository location...4 Figure 7: Creating a new repository location... 4 Figure 8: Module naming... 5 Figure 9: Accessing CVS server and processing the project... 5 Figure 10: Confirm dialog... 6 Figure 11: Ask for committing changes... 6 Figure 12: Enter a commit comment... 6 Figure 13: Transactions... 7 Figure 14: CVS working mode of "HelloWorld" project... 7 Figure 15: Creating checkout projects from CVS... 7 Figure 16: Choose a repository location to check out... 8 Figure 17: Using specified module name... 8 Figure 18: Browsing to choose module in the repository... 8 Figure 19: Naming for new checkout project... 9 Figure 20: Choose workspace location... 9 Figure 21: Select tag to checkout... 9 Figure 22: Transaction window Figure 23: New checkout project Figure 24: Showing kinds of changing events Figure 25: Synchronize with Repository Figure 26: See differences Figure 27: Signs ">" in project window Figure 28: Committing changes Figure 29: Choose tags for updating Figure 30: CVS Resource History Figure 31: Enter a version tag Figure 32: Tagging Figure 33: Checkout from a version Figure 34: Creating a new CVS branch Figure 35: Branching in progress Figure 36: Select the merge start point Figure 37: Select the version or branch to merge Figure 38: Merging Figure 39: Comparing with another version of 18