Working with EGL and Subversion Using RDi with RBD

Size: px

Start display at page:

Download "Working with EGL and Subversion Using RDi with RBD"

Ernest Lewis
5 years ago
Views:

1 HISTORY OF MODIFICATIONS...2 CREATING A NEW REPOSITORY...3 BACKGROUND: INSTALLING TORTOISE...3 SUBVERSION EGL SOURCE CODE REPOSITORY...3 INSTALLING SUBVERSION PLUG-IN AND CONFIGURING FOR USE....5 INSTALLATION OF THE IDE PLUGIN THAT SUPPORTS SUBVERSION...5 CONFIGURE RDI TO USE SUBVERSION...13 USING SUBVERSION DURING DEVELOPMENT ADDING A NEW PROJECT INTO THE SUBVERISON REPOSITORY COMMITTING CHANGES TO THE SUBVERSION REPOSITORY...27 Step 1: Synchronizing the workspace with SVN...27 Step 2: Commit the changes to SVN...31 SUBVERSION ICONS AND THEIR MEANINGS Page 1 of 35

2 History of Modifications This section chronicles the changes made to this document. If you added or changed any content please indicate it here. Date Author Description B.Foster Released Page 2 of 35

3 Creating a new repository This section is focused on administration-related activities. It is not for developers. The initial goal is to get the production source code into the SVN source code repository residing on the IFS. For this, the following process was used. Background: Installing Tortoise This step has already been performed on machines used by Subversion administrators. It is presented only as reference material. The install-file TortoiseSVN x64-svn msi was acquired and executed. All defaults were selected during this process. Subversion EGL Source Code Repository This step has already been performed by the Subversion administrator. It is presented only as reference material. On the IFS, the directory SVNEGLRepo was created under Subversion. It will act as the root directory under which the EGL application directories will be placed. Page 3 of 35

Select SVNEGLRepo and use TortoiseSVN to create the repository. Done.

4 The new directory. SVNEGLRepo The repository was created using Tortoise, evoked by right-clicking on the directory and taking the option shown. Select SVNEGLRepo and use TortoiseSVN to create the repository. Done. To any curious administrator or developer, it should be stressed that this structure should never be changed or manipulated in any way other than by Tortoise alone. You cannot view the source stored in the SVN repository by using Windows Explorer. Changing the contents in any way will corrupt the repository. Page 4 of 35

5 Installing Subversion Plug-in and Configuring for Use. This section illustrates how Subversion is used within the IDE and is intended to be used by all developers. Installation of the IDE plugin that supports Subversion. In RDi, select the option shown. Page 5 of 35

6 Select Add Copy and paste this value into the text field for Location. Enter the values shown and press OK Page 6 of 35

7 The Install Wizard will change as shown: Select the entry for Subclipse only and select Next Page 7 of 35

8 Calculating Page 8 of 35

9 Next Page 9 of 35

10 Page 10 of 35

11 Select the radio button for I accept. and select Finish Wait for awhile then Page 11 of 35

12 The following dialog box will be presented. Select OK Resuming Select Restart Now Page 12 of 35

13 Configure RDi to use Subversion To configure RDi to use Subversion select the menu option shown. Select Window -> Preferences. Page 13 of 35

14 Select the SVN interface as shown and select the OK button. RDi is now properly configured to use Subversion. Page 14 of 35

Using Subversion during development. This section will illustrate normal everyday use of Subversion within RDi, from adding a project to the repository to managing changes.

15 Using Subversion during development. This section will illustrate normal everyday use of Subversion within RDi, from adding a project to the repository to managing changes. Adding a New Project into the Subverison Repository. This section shows how to add a brand new project to the EGL source code repository. Select the project folder and right-click to expose the pop-up menu. Select Team, then Share Project. Page 15 of 35

16 Select SVN then Next. This dialog box is asking for the location of the SVN repository on the IFS. Enter file:///s:/svneglrepo and select Next Page 16 of 35

17 This dialog is verifying the project folder selected in RDi will be the name of the folder in the SVN Repo. Ensure the radio button shown is selected and select Next This dialog is presented to invite you to make a comment about the artifacts being committed into the repository. It s a good idea to do this, however the comments shown will work fine. Select Finish Page 17 of 35

18 Select OK Page 18 of 35

19 The following entries can be seen in the console at the bottom of RDi. and this dialog box is presented. Select Yes to view the Synchronize Perspective. Page 19 of 35

20 This shows the RDi s Synchronize Perspective. The project in the window at the left of the IDE has been expanded to reveal all of the projects members that need to be committed into the SVN repository. Page 20 of 35

21 Below is a close-up of the window. Note that this is not a hierarchical view. Also note that each folder icon has an arrow associated with each folder. This indicates they are selected to be included into the SVN repository. Inside the red circle you can see the currently selected view indicated by the depressed button ( ). These buttons effect what can be seen in the list. In this case the button indicates both inbound and outbound source members are included in the list. Inbound members represent source within the repository that is more recent than the source in RDi. It means your view of the project is not the most recent as someone else on the project team has changed it. We will see how to resolve this later. Page 21 of 35

22 This is a summary of the icons shown within the red-circle above. Icon Meaning Description Incoming Mode Changes the view to show members which have been modified by other team members which your project does not include Outgoing Mode Incoming/Outgoing Mode Conflicts Mode Changes the view to show members which have been modified by the developer which should be committed to SVN. Changes the view to show incoming and outgoing changes. This view changes to show conflicts. Conflicts are common in a development environment where multiple developers are maintaining the same project. The conflicts arise when different developers have modified the same source file and one developer has chosen to commit their changes. Conflict resolution is performed with this view, where the developer can determine the nature of the source code conflicts and commit the changes after the conflicts have been resolved. To continue with the commit process, select the project folder in the list and then select the button shown. Page 22 of 35

23 This dialog is asking for a comment for the current operation. In this case enter the comment shown and select the OK button. Initial commit Page 23 of 35

24 Page 24 of 35

25 When the process completes the view will change as shown. The entry in the Synchronize tab says No changes in SVN (/LoggingViewerProject) which means your project space is up to date. At the upper right of the IDE select the button shown to change the perspective to the EGL project view. Changing perspective Page 25 of 35

Here s a close up Each EGL source folder has been adorned by the commit

26 Now back in the EGL project perspective, note the icons that have been added to each folder. Here s a close up Each EGL source folder has been adorned by the commit process with a disk at the lower right of each folder icon to indicate the folder and its members are under source control. Page 26 of 35

Committing Changes to the Subversion Repository Shown below is an EGL project that has been changed since having been added to the repository.

Whenever a source member inside the package folder is changed the icon changes to.

27 Committing Changes to the Subversion Repository Shown below is an EGL project that has been changed since having been added to the repository. The icon An EGL Project under Source Control When the project was first added to Subversion s repository each EGL package was adorned with this icon to indicate the package is under version control. Whenever a source member inside the package folder is changed the icon changes to. Step 1: Synchronizing the workspace with SVN Periodically, either once in the morning or sometime during the day, the developer should refresh their project s workspace with the source image from SVN to keep the developer s project in sync with the SVN-project to minimize any differences to be resolved during the commit process. When the developer determines the proper time to commit their changes, the process begins by invoking the IDE s Team Synchronizing perspective. Page 27 of 35

The IDE will change to the perspective allowing for project

28 The Open Perspective dialog is presented. Select the entry marked Team Synchronizing shown. The IDE will change to the perspective allowing for project synchronization. Select the icon shown to synchronize the project s workspace with SVN. Page 28 of 35

29 The dialog shown is presented while SVN synchronizes your workspace with what it knows about the project s source in the SVN repository. The IDE screen segment below shows the Synchronize tab after the process completes. It shows all of the differences detected. Note that the list shows both the EGLGen directory and the EGLSource directory with the directories of the latter expanded to show their contents. Page 29 of 35

For clarity they can be removed from the view (only) by selecting those

30 Since the contents in the EGLGen directory are always derived there is no need to commit these changes. For clarity they can be removed from the view (only) by selecting those directories, right-clicking to expose the pop-up menu and taking the option Remove from View as shown. The list is then updated as shown. OK Page 30 of 35

31 Step 2: Commit the changes to SVN Next, select the members representing the outgoing changes to be committed as shown. Enter a comment about the commit and press OK. Page 31 of 35

32 Committing. The entries have been removed from the Synchronize tab indicating the process is complete. Page 32 of 35

33 Subversion icons and their meanings. When working with the Subversion repository, remote changes (those on the repository) are incoming changes (remote local), while local changes are outgoing changes (local remote). In views that compare the local and remote copies, incoming changes are denoted with a blue, left-facing arrow, while outgoing changes are denoted with a gray, right-facing arrow. These arrows may be decorated to indicate more specific operations. The Package Explorer view, on the other hand, indicates a file's status with a different set of icons representing its local state. These icons are the ones most commonly seen, so let's start with them: - A file ignored by version control. You can control what resources will be ignored by going to Window Preferences Team Ignored Resources. - A file not under version control. These are typically new files that you have not committed to the repository yet. - A versioned file that needs to be added to the remote repository. These are typically files you have either renamed, or moved to a different directory. - A deleted folder. These are folders that you have deleted locally without yet committing the changes to the repository. Note that files are usually removed from the view when they're deleted locally, so they are normally not seen with this icon. - A file with no local changes. - A file with local, uncommitted changes. - An EGL package with local, uncommitted changes - A locked file. - A file that needs a lock to be edited. These are typically files that cannot easily be merged (i.e. binary files), but may have many editors. A file needs a lock when its svn:needs-lock property is set, and Subversion will attempt to make these files read-only in the file system to enforce proper lock negotation. - A conflicted file. These are typically files that had a commit/update conflict that you marked to resolve later. - A file that has a tree conflict. These are typically files that have local changes, but have since been moved, removed, or renamed in the repository since the last local copy update. - A file that is external to the project. Linked external files cannot be committed to the repository. Page 33 of 35

34 - A file that has been switched. These are files which belongs to a different working copy than their local parent directory. Outgoing - A file whose contents have been modified and will be committed to the repository. - A file that will be newly added to the repository. This may coincide with a file removal in cases where a file is moved or renamed.. - A file that will be removed from the repository. This may coincide with a file addition in cases where a file is moved or renamed. - A file with property changes, in the Commit dialog. On the Synchronize tab, property changes are currently reflected as a normal file modification ( ). Incoming - A file that has content changes committed to the repository that will be applied to the local copy. - A new file that will be added to the local copy from the repository. Like the outgoing file addition, this may be the result of a move or rename. - A file that will be removed from the local copy because it has been removed from the repository. Like the outgoing file removal, this may be the result of a move or rename. Conflict - A file that has been changed in both the local copy and repository independently, causing a need for conflict resolution. Fixing this condition involves opening up the conflict view or forcibly overwriting changes locally or remotely. - A file that has a tree conflict. This can occur when there are new changes to a file on one end (either local or remote), and the file is moved, removed, or renamed on the other. Page 34 of 35

35 Finally, the Synchronize with Repository option opens the Synchronize tab ( the following buttons: ) with - Synchronizes the local copy with the currently selected repository when clicked. Selecting from the drop-down allows switching between different remote code bases. - Shows only incoming changes (remote local). - Shows only outgoing changes (local remote). - Shows both incoming and outgoing changes (remote local). - Shows conflicting changes. - Updates all local resources with incoming changes after prompt. - Brings up the commit dialog to commit all outgoing changes. - Breaks up the change lists by revisions. Page 35 of 35

Software Tools Subversion

Software Tools Subversion Part II Lecture 4 1 Today s Outline Subversion (SVN) TortoiseSVN Client SVN Tips 2 Subversion (SVN) 3 Subversion (SVN) Centralized open-source VCS; started in 2000 Developed as