Subversion edu instructions - Revision history

Neteler: link to comparison of (graphical user interface and command line) subversion clients

2009-08-19T21:19:05Z

link to comparison of (graphical user interface and command line) subversion clients

Neteler: prettified

2009-07-31T11:46:18Z

prettified

Helena: /* How to provide and manage your educational material on osgeo svn */

2009-07-31T04:06:57Z

How to provide and manage your educational material on osgeo svn

Helena at 03:54, 31 July 2009

2009-07-31T03:54:56Z

New page

== How to provide and manage your educational material on osgeo svn ==

Find out what is there so far: http://svn.osgeo.org/osgeo/education/

'''Install the svn client software (you may already have it)'''

Linux: * 'subversion' package (RPM for your distro, should
be on the CDROMs/DVD)

MacOSX: * http://subversion.tigris.org/
-> Downloads

Windows: * http://tortoisesvn.tigris.org/
-> Downloads
If you want a pretty Win32 GUI, 'TortoiseSVN'
integrates nicely with the Windows Explorer.

'''Checkout the material from the SVN repository into local directory'''

1a) Command line:
svn co http://svn.osgeo.org/osgeo/education/UnderDevelopment/ UnderDevelopment

1b) TortoiseSVN:
Just enter this url: http://svn.osgeo.org/osgeo/education/UnderDevelopment/

This will check all the material in UnderDevelopment/ into the local directory UnderDevelopment/

'''Now add your material....'''(you need to have committ access - you will be asked for ID/passwd):

cd UnderDevelopment/

If you are just starting, add a directory for your institution (svn add is for adding, but you also need to committ by svn ci)

mkdir MyUniversity
svn add MyUniversity
svn ci -m "MyUniversity added - some useful comment" MyUniversity

cd MyUniversity
create or copy your material here and then add the relevant
subdirectories and files to the repository

svn add directory
svn ci -m "MyTutorial for beginners added" directory

svn add file
svn ci -m "Introduction text added" file

'''Your group can now work on the material'''

Before starting the work update to latest version

svn up

Modify/fix/enhance the material and commit the change

svn ci -m "Introduction modified, grammar fixed" file

@@ Line 5: / Line 5: @@
 ===Install the svn client software (you may already have it)===
-     Linux:   * 'subversion' package (RPM for your distro, should
+     Linux:   * 'subversion' package (deb or RPM for your distro, should be on the CDROMs/DVD)
      MacOSX:  * http://subversion.tigris.org/
@@ Line 15: / Line 14: @@
                 If you want a pretty graphical user interface, 'TortoiseSVN'
                 integrates nicely with the Windows Explorer.
 ===Checkout the material from the SVN repository into local directory===

@@ Line 3: / Line 3: @@
 Find out what is there so far: http://svn.osgeo.org/osgeo/education/
-'''Install the svn client software (you may already have it)'''
+===Install the svn client software (you may already have it)===
      Linux:   * 'subversion' package (RPM for your distro, should
@@ Line 13: / Line 13: @@
      Windows: * http://tortoisesvn.tigris.org/
                 -> Downloads
-                If you want a pretty Win32 GUI, 'TortoiseSVN'
+                If you want a pretty graphical user interface, 'TortoiseSVN'
                 integrates nicely with the Windows Explorer.
-'''Checkout the material from the SVN repository into local directory'''
+===Checkout the material from the SVN repository into local directory===
 Command line:
@@ Line 26: / Line 26: @@
 This will check all the material in UnderDevelopment/ into the local directory UnderDevelopment/
-'''Now add your material....'''(you need to have committ access - you will be asked for ID/passwd):
+'''Now add your material....'''(you need to have commit access - you will be asked for OSGeoID/passwd):
       cd UnderDevelopment/
@@ Line 40: / Line 40: @@
         subdirectories and files to the repository
-      svn add directory
+       svn add directory
-      svn ci -m "MyTutorial for beginners added" directory
+       svn ci -m "MyTutorial for beginners added" directory
         svn add file
@@ Line 56: / Line 56: @@
          svn ci -m "Introduction modified, grammar fixed" file
-'''Brief SVN reference'''
+===Brief SVN reference===
 Help:
@@ Line 71: / Line 71: @@
      D  Deleted
      U  Updated
-     C  Conflict - ZAP! Here check for problems
+     C  Conflict - ZAP! In this case check for problems
      G  merGed
      ?  file not under version control (e.g. images)
@@ Line 118: / Line 118: @@
      svn diff -r PREV:BASE file
-Check history of changes:
+Check history of changes (see [http://svnbook.red-bean.com/nightly/en/svn.tour.history.html here] for details):
      svn log file
-  ... on all files:
+... on all files:
      svn log
-  ... create ChangeLog file:
+... create ChangeLog file:
      svn log > ChangeLog
@@ Line 132: / Line 131: @@
 Whenever a conflict occurs, three things typically occur to assist you in noticing and resolving that conflict:
-    * Subversion prints a C during the update, and remembers that the file is
+* Subversion prints a C during the update, and remembers that the file is in a state of conflict.
-       in a state of conflict.
+* For every conflicted file, Subversion places up to three extra unversioned files in your working copy
-    * For every conflicted file, Subversion places up to three extra
+* At this point, Subversion will not allow you to commit the file until the three temporary files are removed.
         $ svn commit --message "Add a few more things"
         svn: Commit failed (details follow):
         svn: Aborting commit: '/home/sally/svn-work/sandwich.txt' remains in conflict
-    * If you get a conflict, you need to do *one* of three things:
+* If you get a conflict, you need to do *one* of three things:
-       *  Merge the conflicted text 'by hand' (by examining and editing the
+** Merge the conflicted text 'by hand' (by examining and editing the conflict markers (<<<<< and >>>>>) within the file).
-          conflict markers (<<<<< and >>>>>) within the file).
+** or: Copy one of the temporary files on top of your working file.
-       * or: Copy one of the temporary files on top of your working file.
+** or: Run svn revert <filename> to throw away all of your local changes.
 Once you've resolved the conflict, you need to let Subversion know by running
@@ Line 151: / Line 146: @@
 considers the file to be in a state of conflict:
-        $ svn resolved sandwich.txt
+       $ svn resolved sandwich.txt
-          Resolved conflicted state of 'sandwich.txt'
+         Resolved conflicted state of 'sandwich.txt'
-'''Reference (really good:)'''
+===Reference (really good)===
- Version Control with Subversion http://svnbook.red-bean.com/nightly/en/index.html
+Version Control with Subversion: http://svnbook.red-bean.com/nightly/en/index.html
-Graphical tool for SVN http://en.wikipedia.org/wiki/Subversion_%28software%29#GUI_front-ends.2Fclients
+=== See also ===

@@ Line 18: / Line 18: @@
 '''Checkout the material from the SVN repository into local directory'''
-a) Command line:
+Command line:
      svn co http://svn.osgeo.org/osgeo/education/UnderDevelopment/ UnderDevelopment
-b) TortoiseSVN:
+TortoiseSVN:
      Just enter this url: http://svn.osgeo.org/osgeo/education/UnderDevelopment/
@@ Line 48: / Line 48: @@
 '''Your group can now work on the material'''
-    Before starting the work update to latest version
+Before starting the work update to latest version
          svn up
-    Modify/fix/enhance the material and commit the change
+Modify/fix/enhance the material and commit the change
          svn ci -m "Introduction modified, grammar fixed" file