Changes between Version 7 and Version 8 of code/tools/SVN

Timestamp:

Feb 18, 2008, 12:30:31 AM (17 years ago)

Author:

nicolasc

Comment:

cleanup

code/tools/SVN

@@ -1 +1 @@
 == SVN == 
-This Page contains a collection of the most used svn command including some examples. This page does not claim to be complete. for further reading use the built-in help function from svn. the syntax is ''svn help <command>'', of command is omitted, a complete list of valid svn command in printed to the comsole. Further it is assumed that the user has a basic understanding of the shell, and know he way around in the file structure. svn allow most flexibilities the bash shell allows.[[br]][[br]]
+This Page contains a collection of the most used svn command including some examples. This page does not claim to be complete. for further reading use the built-in help function from svn. The syntax is ''svn help <command>'', of command is omitted, a complete list of valid svn command in printed to the comsole. Further it is assumed that the user has a basic understanding of the shell, and know he way around in the file structure. svn allow most flexibilities the bash shell allows.[[br]][[br]]
 
 these are some examples, which are elaborated further down.
@@ -19 +19 @@
 
 === checkout (co) ===
-the checkout command is used to create a local copy of a svn subtree on the local computer.
+The checkout command is used to create a local copy of a svn subtree on the local computer.
 
-the syntax used is ''svn co -r <revision> <remote-path> <local-path>'', if -r <revision> is omitted, the HEAD revision is assumed, which is also the newest one, if <local-path> is omitted the last remote folder will be used as <local-path>.
+The syntax used is ''svn co -r <revision> <remote-path> <local-path>'', if -r <revision> is omitted, the HEAD revision is assumed, which is also the newest one, if <local-path> is omitted the last remote folder will be used as <local-path>.
 
 This will create a folder orxonox-trunk with the contents of the trunk
@@ -34 +34 @@
 
 === update (up) ===
-update is closely related to checkout, as it also download - or updates - the svn tree. while checkout is normally only used once, update is used all the time. the syntax is ''svn up <local-path>'', if <local-path> is omitted the current update will be allied to the current directory.
+update is closely related to checkout, as it also download - or updates - the svn tree. while checkout is normally only used once, update is used all the time. 
+
+The syntax is ''svn up <local-path>'', if <local-path> is omitted the current update will be allied to the current directory.
 
 This will update the current folder including subfolders.
@@ -49 +51 @@
 
 === commit (ci) ===
-sometime also called checkin, does the opposite of checkout or update, it upload changes made to the local the to the server. The syntax is ''svn ci -m <commit message> <local-path>'', if <local-path> is omitted, the current directory is assumed, if -m <commit message> is ommited, an editor will pop up where you can (and should) write a meaningful commit message.
+Sometime also called checkin, does the opposite of checkout or update, it upload changes made to the local the to the server. 
+
+The syntax is ''svn ci -m <commit message> <local-path>'', if <local-path> is omitted, the current directory is assumed, if -m <commit message> is ommited, an editor will pop up where you can (and should) write a meaningful commit message.
 
 this will checkin the current directory including subfolders with the comment "initial upload"
@@ -59 +63 @@
 
 === add ===
-adding a new file to the local svn copy, that it get upload with the next commit. the syntax is ''svn add <file>''
+Adding a new file to the local svn copy, that it get upload with the next commit. 
+
+The syntax is ''svn add <file>''
 
 this will add the files myFile.cc and myFile.h in the folder myFolder to the svn
@@ -67 +73 @@
 
 === remove (rm) ===
-also called delete, which deletes an item from the svn tree. please note that this also removed the file/folder from the local harddrive. the syntax is ''svn rm <file/folder>''. you still need to commit it to the server.
+Also called delete (del), which deletes an item from the svn tree. please note that this also removed the file/folder from the local harddrive. 
+
+The syntax is ''svn rm <file/folder>''.
 
 this will remove the file myOldFile.cc from the svn tree
@@ -75 +83 @@
 
 === move (mv) ===
-sometime called rename (ren) - as a rename is the same as a move. The command simplifies the rearranging of files in the svn tree. the syntax is ''svn mv <source files> <target-folder>''
+Sometime called rename (ren) - as a rename is the same as a move. The command simplifies the rearranging of files in the svn tree. 
+
+The syntax is ''svn mv <source files> <target-folder>''
 
 this will move the files myFile.cc and myFile.h to myFolder
@@ -88 +98 @@
 
 === copy (cp) ===
-a command which is rarely used on the local tree - why would someone need a file twice in the same tree? - but it is rather useful to create new branches. though it is normally done by the supervisors, it can be done by the students.
+A command which is rarely used on the local tree - why would someone need a file twice in the same tree? - but it is rather useful to create new branches. though it is normally done by the supervisors, it can be done by the students.
 
-this will create a new branch called test from the current version of the trunk
+The syntax is ''svn cp <source-tree> <target-tree>'' or ''svn cp <source-files> <target>''
+
+This will create a new branch called test from the current version of the trunk
 {{{
 svn cp https://svn.orxonox.net/orxonox/trunk https://svn.orxonox.net/orxonox/branches/test
@@ -96 +108 @@
 
 === resolved ===
-if a conflict arises - this normally happens if someone change a file on the server (committed it) while you were doing changes in the same place. This command '''does not solve''' the conflict, but it removes the other unnecessary files.
+If a conflict arises - this normally happens if someone change a file on the server (committed it) while you were doing changes in the same place. This command '''does not solve''' the conflict, but it removes the other unnecessary files.
 
-this will resolve the conflict in in myConflictFile.cc, and make the copy committable again.
+The syntax is ''svn resolved <conflicting file>''
+
+This will resolve the conflict in in myConflictFile.cc, and make the copy committable again.
 {{{
 svn resolved myConflictFile.cc
@@ -106 +120 @@
 One of the major advantages of a version control system, is that you can always revert to a known saved state - in this case the last updated local revision. revert removes all local changes and restores the file to a state prior editing, i.e discarding all local changes.
 
-this will discard all local changes made to myFile.cc
+The syntax is ''svn revert <target>''.
+
+This will discard all local changes made to myFile.cc
 {{{
 svn revert myFile.cc
@@ -112 +128 @@
 
 === diff (di) ===
-another rarely used but very useful command. it shows you the difference between the downloaded revision and the current state, which basically what will be uploaded at the next commit. It is also useful to check if all new files have been added to the svn tree - it happens very often, the there are two commits in short time, first the updates, then the new files. the syntax is ''svn di <local-path>'', if <local-path> is omitted, the current directory is assumed. 
+Another rarely used but very useful command. It shows the difference between the downloaded revision and the current state, which basically what will be uploaded at the next commit. It is also useful to check if all new files have been added to the svn tree - it happens very often, the there are two commits in short time, first the updates, then the new files. 
+
+The syntax is ''svn di <local-path>'', if <local-path> is omitted, the current directory is assumed. 
 
 this will show - print to the console - the current changes made to the revision