Changes

Under construction<br />This text is a "how to" document to be used with for using a graphical user interface with SVN, like . Graphical user interfaces include* [[RabbitVCS]] for linux or * [http://www.rapidsvn.org/download/release/0.12/RapidSVN-0.12.0-8051.dmg RapidSVN] for Mac or * [http://tortoisesvn.net/downloads TortoiseSVN] for Windows.<br />Help making improve this better document by adding SVN command line commands for examples.

| +-- member-id1 <-- this is the studenta team member's home in within branches

| +-- member-id2 <-- this is a team member's home within branches

| +-- member-id3 <-- this is a team member's home within branches

==== Branches branches ====* '''Branchesbranches''' is a the common place directory for all team members' workspaces. * Each team member should create a their own home directory or '''workspace''' (member-id1, member-id2,...) for his their own development tasks in within '''branches'''. * The Each team-member's should divide their workspace is then divided in 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. Also Note that when When the word '''branch''' is used as a verb, it means copying the whole '''trunk ''' into a subdirectorysub-directory, either in '''Branchesbranches''' 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 tags ====* '''tags''' is the directory that holds '''copies''' of successful stages of '''trunk''' during throughout development. (''Also called as '''Milestones''''')* '''tags''' are never modified or edited. ''You may branch the a directory of tag into branches under a workspace and then modify it the branch and apply the changes back to trunk, but you should never change the contents of a tag should never change''* The action of '''branchingbranch''' ing the trunk into '''tags''' is often referred to as a '''release'''.* Most importantly, we We use the '''tags''' directory to submit the work to the professor to be markedfor marking. ''Your professor instructor will specify what are the requirements of a release.** A release is usual usually tagged by a version number like: R0.1, Prj0.2, As1_1.0 ** When a release is due, your instructor will always mark the latest version of that realease will be markedrelease. **: ''If R0.3 is due, and in '''tags''' R0.3, R0.31, R0.32 are presentin '''tags''', then your instructor will mark R0.32 will be marked ==== Trunk trunk ====* '''trunk''' IS is the directory that holds the project at in its current stagedstage, '''complied and run-able'''* '''trunk''' should never be at a hold non-complied stagecompiled code. (usually Usually trunk should be the is an exact copy as (or better than) the last latest version in '''tags)'''.* If the repository only contains one project is done within this repository, then trunk has no project level subdirectory sub-directory and is the root of the project, otherwise. Ifthe repository holds more than one project, trunk is divided into several sub-directories - one for each project to be version-controlled.*: ''In this case Tags should also be divided to , we divide '''tags''' into exactly the exact same project sub-directories as present in '''trunk''''' 

To explain basic actions we have to clear A few important facts and terminologyto help clarify the basic actions:*Responsibility One responsibility of a code repository is to keep track of all of the modifications done to a project by different its team members. *:In other words, when a project handled that is tracked by a code repository (version-controlled or in short versioned) , you can track focus on any changes done through during the project's development life of the project; like such as, who modified/added/deleted what and when. You can undo any work or rollback the work to any stage of the development and much more.* SVN is a client/server based repository;*: Which means the code Code is kept on a server and those with members who have access can copy the whole, or pieces parts of the project to their local machines and , work on them the whole or parts and then apply the their changes back to the server. Note that because if this factBecause of the code is kept on a server, one member could may be unaware of the changes make made by another member, unless the first one applies other has applied the changes to the serverand the member has update their local copy.* Merging all the modifications by of different members into the repository is another responsibility of SVN.* a A '''Version-controlled or versioned''' file, is a file that is handled and tracked by a repository ==== import ===='''import''' is to copy non-versioned work (directory) to a repository server.: note that in this case the imported code is on the server and is still NOT versioned on the client machine; to start working on an imported directory, you should fist '''checkout''' the directory from the repository to the client machine.==== export ===='''export''' is to copy the whole or part of a repository into a non-versioned directory on the client machine: This is usually done when you want to either package the project and make it ready for production or when you and to copy a piece of work form one repository to another repository.

To '''checkout''' is to copy the code form 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 one directory on the repository server into another directory on the repository server.: Note that '''branch'''ing the code copies iton '''the repository''' itself and not on the local (client) machine. To work on the '''branch'''ed (copied) code, you must '''checkout''' the directory to which you copied the '''branch'''. 

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 (or that is, to copy) your modifications and additions to the repository server.==== branch ===='''branch''' is to copy a directory (like trunk) into another directory on the repository server.: Note that after '''braching''' the code is copied on '''the repository''' and not the local(client) machine. To actually work on the branched (copied) code you must '''checkout''' the directory after branching.

To '''"merge"''' is to merge a branched directory back to the original directory; that is, to apply to the opposite of original directory those modifications and additions that you have made to your '''branch'''ed directory. : '''"merge"''' merges back a branched directory, back to is the original directory to apply the modifications and additions to the branched direcotryopposite 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 the repository server.: Note that although the imported code is on the server, it is still NOT versioned on the client machine. To start working on an imported directory, you 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 a an empty project and start to write the code yourselffrom scratch# Start To start the project by continuing an existing work#: This is We do this when you have someone else has started the project started by someone else (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 the that work.

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.

For this To continue an existing work, you should have a '''non-versioned''' copy of the basic framework initial code for the your project to initiate it. Then you should copy the framework Copy this code into the trunk, '''add''' and '''committrunk'''it. This is how it is done: # Copy the basic framework into trunk of your repository#: If the basic framework in provided in another repository (namely RepA) , you should copy it by '''exportadd'''ing it into trunk of your repository (namely RepB)#:# and '''updatecommit''' RepA to make sure it is in sync with the server.#:# Right click on direcotry with the basic framework is provided in RepA and select "...SVN/export".#:# Select These are the trunk of RepB and click OK#detailed steps:#: This will create a "non-version-controlled" copy of the basic framework in RepB/trunk# Do any modification needed to make the framework ready for work# Right click on RepB/trunk and select '''Add''' and choose the files needed to be "versioned"# '''Commit''' The trunk to copy the files to the 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")

#:* Add a proper descriptive message for to inform others to know about what you have done

#: 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 within your 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 prof professor knows what to mark . * '''If you do not comment a COMMIT, it means that it was minor and does not need to be marked'''* You can work form home, commit your work, come to school, checkout yourcommitted code, and continue later.* If you are working on a public computer, make sure to delete your work, 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, 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 completed your work within your own workspace and your code compiles and is ready to go, 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", select "reintegrate a branch", and click on next.# Make sure "From URL" is the branch you want to merge and click on next.# Click on "test merge" to see if the merge is successful.# Click on "merge" to merge the branch back to trunk# Now update the trunk to apply the changes.# If there are any conflicts, click on "...SVN/edit conflicts" and fix each conflict, save and click on conflict resolved"# Check the trunk status in your team page on the wiki#:* If the trunk status is "committed" then change it to "being committed by your_name"#:* If the trunk status is "being committed by member_name", wait for them to complete their commit and go to previous step.# Commit the trunk and when done, update the truck status to "committed by your_name"# If this commit was worth recording, branch it in the tags directory under a new release.  If you 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.