Changes between Initial Version and Version 1 of SvnTutorial

Timestamp:

02/12/07 03:24:16 (17 years ago)

Author:

arango

Comment:

--

SvnTutorial

@@ +1 @@
+== svn Tutorial ==
+
+In this tutorial, you will learn how to download the ROMS/TOMS source code and create and modify your own branch.
+
+In the following examples, the username is bubba.
+
+To proceed, you will need to know your username and password which should have received via e-mail from hosted-projects.
+
+== Check to Make Sure You Can See the Repository ==
+
+The easiest way to view a repository is to simply look at it in a web browser.  Enter the URL of the repository (and your username and password when prompted if the site is protected), and start looking.  This is also a good way to see individual files in the repository without actually downloading them.
+
+If you are using TortoiseSVN, right-click on a directory and choose '''Repo-browser'''.
+
+Enter the URL 
+{{{
+http://www.myroms.org/svn/Models/ 
+}}}
+
+Now you should be able to look at the '''branches''' (currently, none), '''tags''', and '''trunk'''. You can also navigate the repository with a web browser, but cannot do any of the version control stuff that follows.
+
+== Checkout a Copy of the Trunk ==
+This process brings a copy of main code from the repository to your computer and places it under svn control.[[BR]]
+Make a directory...name it something meaningful to you, for example {{{bubba_roms_sed}}}[[BR]]
+Right-click on the directory folder icon, and choose {{{SVN Checkout...}}}[[BR]]
+URL of repository:[[BR]]
+{{{https://svn1.hosted-projects.com/cmgsoft/roms_sed/trunk}}}[[BR]]
+Checkout directory:[[BR]]
+{{{bubba_roms_sed}}}[[BR]]
+You should see a bunch of stuff stream by like:
+{{{
+Added: D:\crs\proj\Adriatic\bubba_roms_sed\ROMS  
+Added: D:\crs\proj\Adriatic\bubba_roms_sed\ROMS\Tangent  
+Added: D:\crs\proj\Adriatic\bubba_roms_sed\ROMS\Tangent\tl_rho_eos.F  
+Added: D:\crs\proj\Adriatic\bubba_roms_sed\ROMS\Tangent\tl_uv3dmix.F  
+Added: D:\crs\proj\Adriatic\bubba_roms_sed\ROMS\Tangent\tl_def_his.F  
+Added: D:\crs\proj\Adriatic\bubba_roms_sed\ROMS\Tangent\tl_step2d.F  
+...
+Added: D:\crs\proj\Adriatic\bubba_roms_sed\Compilers\CYGWIN-g95.mk  
+Added: D:\crs\proj\Adriatic\bubba_roms_sed\Compilers\OSF1-f90.mk  
+Added: D:\crs\proj\Adriatic\bubba_roms_sed\Compilers\Darwin-ifort.mk  
+Added: D:\crs\proj\Adriatic\bubba_roms_sed\Compilers\AIX-xlf.mk  
+Added: D:\crs\proj\Adriatic\bubba_roms_sed\Compilers\SunOS-f95.mk  
+Added: D:\crs\proj\Adriatic\bubba_roms_sed\makefile  
+Completed: At revision: 243  
+}}}
+Click OK.
+
+If you are using svn from the command line, as you would on most unix style machines, check out the respository using the command:
+{{{
+svn co  https://svn1.hosted-projects.com/cmgsoft/roms_sed/trunk  buba_roms_sed
+}}}
+(See the footnote for correctly installing svn with ssl support on unix style machines below.)
+
+
+== Create a Branch ==
+You must use the exact branch name that was created for you by a [wiki:CSTM_Admins CSTM administrator]. If you are unsure of your branch name, check the [https://hosted-projects.com/dav/cmgsoft/nopp/contacts/cmgsoft_acl.txt Access Control List], searching for a line like:
+{{{
+[roms_sed:/branches/bubba_branch]
+}}}
+
+In TortoiseSVN, choose {{{Branch/tag}}}. (To see this option in TortoiseSVN, you have to right-click on a directory that is under SVN control...but it does not have to be related to the project at hand).[[BR]]
+From WC at URL:[[BR]]
+{{{https://svn1.hosted-projects.com/cmgsoft/roms_sed/trunk}}}[[BR]]
+to URL:[[BR]]
+{{{https://svn1.hosted-projects.com/cmgsoft/roms_sed/branches/bubba_branch}}}[[BR]]
+Click OK.[[BR]]
+(stuff streams by...)
+
+The branch will exist in the repository...you can repeat the steps above to make a copy of the branch on your computer (but not in the same directory you made in the example above, because that contains a version of the trunk under SVN control).[[BR]]
+
+== Make Changes in Your Branch ==
+You can make new files, change existing files, etc. Only existing files will automatically be under SVN control. To add new files, create them in a directory under SVN control (or copy them in from somewhere else).[[BR]]
+Then you can right-click on the filename, and choose {{{Add...}}} under TortoiseSVN, or...[[BR]]
+You will be given an opportunity later (see next step).[[BR]]
+If you compile the code and generate a bunch of .f90 and .o files, or run the model and generate output, they will not be under SVN control unless you add them explicitly. That is usually what you want. (Storing output files here is probably a bad idea, because 1) they tend to be big and take a long time to tranfer to the repository 2) they are binary, so the tools used to compare them will not be useful, and 3) we don't have enough storage space at the repository.)
+
+== Commit Your Changes ==
+Navigate to the top directory in your local copy of your branch, e.g., {{{../bubba_roms_sed}}} and right-click. Choose 
+{{{SVN Commit...}}}[[BR]]
+Commit to:  ''{{{https://svn1.hosted-projects.com/cmgsoft/roms_sed/branches/bubba_branch}}}'' [[BR]]
+Message:  ''(add a meaningful comment here)'' [[BR]]
+Changes made:  ''(Will show files with changes)'' [[BR]] 
+If the {{{Show unversioned files}}} box is checked, you will see any files you added to the directory. This is your opportunity place them under SVN control. Say you made one named {{{foo}}} that you want to add...check it and[[BR]]
+Click OK.
+{{{
+Adding: bubba_roms_sed\foo  
+Sending content: bubba_roms_sed\foo  
+Completed: At revision: 244  
+}}}
+
+
+== Work Cycle ==
+You can Import this branch to another computer...that is the best way to synchronize, say, a desktop at work with a travelling laptop.[[BR]]
+After that, the cycle is:[[BR]]
+At the top local directory, right-click, and under TortoiseSVN {{{Check for modifications}}}. Click Check Repository.[[BR]]
+Make changes.[[BR]]
+{{{Check for modifications}}} or {{{SVN Update}}} (again..can't hurt).[[BR]]
+Finally, {{{SVN Commit...}}}[[BR]]
+
+== Footnote on building svn on unix-like machines ==
+On Unix style machines, you will need to have subversion installed.  You will typically want to build this from source, as you will want to compile with secure socket layers enabled (the binary versions of svn do not have this feature).  Find the source at {{{http://subversion.tigris.org/}}}.  Configure and make with 
+{{{./configure --with-ssl
+make
+sudo make install}}}
+
+
+
+
+