Changes

Jump to: navigation, search

Hints for Using SVN to collaborate on school projects

317 bytes added, 01:29, 13 February 2012
branches
* '''branches''' is the common directory for all team members' workspaces.
* Each team member should create their own home directory or '''workspace''' (member-id1, member-id2,...) for their own development tasks within '''branches'''.
* Each team member should divide their workspace into several sub-directories (workspaces) during the development of the project. These workspaces(Task1, Task2, ...) are usually copies of the '''trunk''' to be worked on.*: ''These sub-directories(Task1, Task2,...) are called branches of trunk. When the word '''branch''' is used as a verb, it means copying the whole '''trunk''' into a sub-directory, either in '''branches''' or '''tags'''.(This method of development is called [http://svnbook.red-bean.com/en/1.5/svn-book.html#svn.branchmerge.commonpatterns.feature Feature Branching]
==== tags ====
* '''trunk''' is the directory that holds the project in its current stage, '''complied and run-able'''
* '''trunk''' should never hold non-compiled code. Usually trunk is an exact copy (or better than) the latest version in '''tags'''.
* If the repository only contains one project is within the repository, then trunk has no project level sub-directory and is the root of the project. If Ifthe repository holds more than one project is within the repository, trunk is divided into several aubsub-directories - one for each project to be version-controlled.*: ''In this case , we divide '''tags''' should also be divided into exactly the same project sub-directories as present in '''trunk'''''
=== Basic Actions ===
A few important facts and terminology to help clarify the basic actions:
* One responsibility of a code repository is to keep track of all of the modifications done to a project by its team members.
*:In other words, in a project that is handled tracked by a code repository (version-controlled or in short versioned), you can track focus on any changes during the project's development life; such as, who modified/added/deleted what and when. You can undo work or rollback the work to any stage of the development and much more.
* SVN is a client/server repository;
*: The code Code is kept on a server and those members who have access can copy the whole or parts of the project to their local machines, work on the whole or parts and then apply their changes back to the server. Because of thisthe code is kept on a server, one member may be unaware of the changes made by another member, unless the other has applied the changes to the serverand the member has update their local copy.
* Merging the modifications of different members into the repository is another responsibility.
* A '''Version-controlled or versioned''' file is a file that is handled and tracked by a repository
To '''checkout''' is to copy the code from a repository server to a versioned directory on the client, so that you can start working on the code.
==== branch ====
To '''branch''' is to copy a one directory (like trunk) on the repository server into another directory on the repository server.: Note that after '''branch'''ing the code is copied copies it on '''the repository''' itself and not to on the local(client) machine. To work on the '''branch'''ed (copied) code, you must '''checkout''' the directory after to which you copied the '''branch'''ing
==== add ====
To '''add''' is to flag a non-versioned file or directory to be added to the repository server at next '''commit'''
To '''commit''' is to apply (that is, to copy) your modifications and additions to the repository server.
==== merge ====
'''merge''' is the opposite of '''branch'''. : To '''"merge"''' is to merge back a branched directory, back to the original directory; that is, to apply to the original directory those modifications and additions that you have made to the your '''branch'''ed directory.: '''merge''' is the opposite of '''branch'''. 
==== export ====
To '''export''' is to copy the whole or part of a repository to a non-versioned directory on the client machine
: You '''export''' when you want either to package the project, to make it ready for production, or to copy a piece of work from one repository to another repository.
==== import ====
To '''import''' is to copy a non-versioned work (directory) to a the repository server.: note Note that in this case although the imported code is on the server and , it is still NOT versioned on the client machine; to . To start working on an imported directory, you should need first to '''checkout''' the directory from the repository to the client machine.
== Starting the a Project On SVN ==There are two possibilities ways to initiate a projecton SVN:# Start To start the project from zero#: This is We do this when you we create an empty project and start to write the code from scratch# Start To start the project by continuing an existing work#: This is We do this when someone else has started the project (i.e. Professorthat is, the professor, other team-members, etc.) and you we want to copy the work into your our own repository and continue that work.
=== Start the Project from zero ===
For this you should To start from zero, create the basic framework initial code of your project in '''trunk''', '''add''' the code, and then '''commit''' it. These are the detailed steps: # '''checkout''' the project repository in a new directory on your local computer;#:# ''Create a new directory on your local computer, right click on that directory, and then click on '''AddSVN Checkout'''#:# In '''URL of the repository''' type your repository path (svn://zenit.senecac.on.ca/....)#:# Click on ok# If the basic directories (trunk, tags, branches) don't exist, create them and add them by right clicking on them and selecting '''...SVN/add'''.# In 'Commit''trunk''' , create your project, compile it, and run it. (This is how could be as simple as a few empty files or a Hello world application).# Right click on the '''trunk''', select '''...SVN/add''', and then select all of the files you do thiswould like to add to the repository. #:Add only those files that you want to track for modification. Only source and project files need to be version-controlled. We don't usually add binary or executable files to the repository. Add them only if you have a reason for doing so.# Right click on '''trunk''' and select '''SVN Commit''' to commit your work to the repository server.
# '''checkout''' the project repository in a new directory on your computer;
#:# ''Create a new directory on your computer, right click on it and then click on '''SVN Checkout'''
#:# In '''URL of repository''' type your repository path (svn://zenit.senecac.on.ca/....)
#:# click on ok
# If the basic directories (trunk, tags, branches) don't exist create them and then add them by right clicking on them and selecting '''...SVN/Add'''.
# In trunk, create your basic project framework, compile and run it. (this could be as simple as few empty files or a Hello world application).
# Right click on the trunk and select '''....SVN/Add''' again and select all the needed file to be added to the repository.
#: Add only those files that should be tracked for modification; "Those need to be version-controlled". Binary and Executable files are usually not added to the repository; Only add them if you know what you are doing.
# Right click on trunk and select '''SVN Commit''' to commit your work to repository server.
=== Start the project by continuing an existing work ===
To continue an existing work, you should have a '''non-versioned''' copy of the initial code for your project. You should copy Copy this code into the '''trunk''', '''add''' and '''commit'''it. These are the detailed steps:
# Copy the initial code into the '''trunk ''' of your repository#: If the code is available in another repository (say RepoSrc), '''export''' from RepoSrc into '''trunk ''' of your repository (say RepoDest)
#:# '''update''' RepoSrc to make sure that it is in sync with the server.
#:# Right click on the directory with the initial code in RepoSrc and select "'''...SVN/export"'''.#:# Select the '''trunk ''' of your own repository (RepoDest ) and click OK#:#: This will create a "non-version-controlledversioned" copy of the initial code in RepoDest/trunk# Do any modification needed to make the initial code ready for your own work# Right click on RepoDest/trunk and select '''Add'''. Then choose the files that you want to be would like "versioned"# Finally, '''Commit''' the '''trunk ''' to copy the those files to the SVN server.
== Preparing Branches/workspace Your Own Workspace for development Development ==For this you should create Create a home direcotry directory in '''branches''' for your development in branches using and name that directory with your seneca-id. Then your should '''branch ''' the trunk into the proper workspace in your home directory in under '''branches'''. Finally you should '''update'''your workspace, so that the new workspace code is added to your copy of the repository on your machine. Here is howThese are the detailed steps:
# Create a directory in '''branches''' and name it with your seneca-id in branches and # '''add''' it the directory to the repository and then '''commit''' branches to update the repository server.# Right click on the '''trunk ''' and select '''...SVN/"Branch/Tag"''' to create a branch for your next task #:* By doing this you This will create your first workspace to start implementation in the project. Fore next step, choose Choose a relevant name for the your assigned task assigned to you, for . For example if your project is writing a text editor an and your next task is to implement "Copy And PastPaste" feature, then the proper a suitable name would something likebe: "CopyPaste" #:* In "To URL" type or select your home dir sub-directory in the '''branches dir, then ''' directory and add "/CopyPaste" to it: (svn://RepoUrlAndPath/branches/yourSenecaid/CopyPaste")
#:* Select HEAD revision or a specific revision if necessary (mostly head revision applies in our case)
#:* Add a proper descriptive message for to inform others to know about what you have done
#:* Click on OK
#: This copies the trunk into a branch so you can start your own implementation, but note that this . This action is done on '''server''' and your local copy of the repository still remains the sameunchanged.# Right click on '''branches''' and click '''SVN update''', this . This will bring download the new branch to your local machine. == working on Working within your branch/workspace own Workspace ==* You can now start implementing to implement your assigned tasks. *: Unlike trunk, since this is YOUR workspace you can leave it an YOUR workspace in any stage state you like. don't forget to comment Comment each and every and each of your '''commit'''s so that later you know which commit belongs to what and also helps your professor knows what to mark your. * '''If you do not comment a COMMIT, it means that it is was minor and does not need to be marked'''* You can work form home, commit your work( make sure you add comment to your commit) and them , come to school , checkout your committed code work and commit , and continue later.* Make sure if If you are working on a public computer, you make sure to delete the your work from local computer, after you have committed it to the repository.
*: <big>'''It is your responsibility to keep your code safe'''</big>
* If you have any problem with your code, and need help, contact your professor, send the path of your workspace. If needed, he can checkout your code see what is wrong with it and , leave comments on it , and commit it. Afterwards, all you need to do is update your repo and read the comments and corrected code. 
== Merging your work back to trunk ==
After you have done completed your work in within your own workspace and your work code compiles and is compiling and ready to go, to you can merge your work back to trunk. These are the detailed steps:# Right click on '''trunk ''' or '''trunk/prj''', depending on what you branched into branches # Select "...SVN/Merge" and , select "reintegrate a branch" , and click on next.
# Make sure "From URL" is the branch you want to merge and click on next.
# click Click on "test merge" to see if the merge is done successfullysuccessful.# click Click on "merge" to merge the branch back to trunk# now Now update the trunk to have apply the possible changes applied.# if If there is are any conflict conflicts, click on "...SVN/edit conflicts" and fix the each conflict, save and click on conflict resolved"# check Check the trunk status in your team page on the wiki#:* If the trunk status is "committed" then change it to "being commited committed by your_name"#:* If the trunk status is "being committed by member_name", wait for the commit them to complete their commit and to go to previous step.# commit Commit the trunk and when done, update the truck status to "commited committed by your_name"# if If this commit was worth recording, branch it in the tags directory under a new release.
If you are having the receive a "branch/project must be ancestrally related to trunk/project" error, try going into your trunk and right click > merge one file at a time. Make sure to click the "show log" button in the merge wizard to get the latest revision for the merge added for you.
== Resources ==
* [[SVN]]

Navigation menu