Changes between Version 4 and Version 5 of CaffeinatedSubversion

Timestamp:

01/19/11 07:47:11 (14 years ago)

Author:

geofft

Comment:

--

CaffeinatedSubversion

@@ -11 +11 @@
 == Initial checkout ==
 
-Identify a location in your filesystem for your working copy of the source, and change to that directory.  Then, checkout the source with the following command:
-`svn co svn+ssh://svn.mit.edu/athena/trunk athena`.
+Identify a location in your filesystem for your working copy of the source, and change to that directory.  Then, checkout the source with `svn co` (short for `svn checkout`), as follows:
+{{{svn co svn+ssh://svn.mit.edu/athena/trunk athena}}}
 
-This will create a directory called `athena` in the current directory, with the Athena source tree inside that directory.  That directory is called a *working copy*.  
+This will create a directory called `athena` in the current directory, with the Athena source tree inside that directory.  That directory is called a '''working copy''' or '''checkout'''. 
 
 == Getting an update from the server ==
 
-Before making changes, you'll want to ensure you have the latest copy of the code.  `svn update` will get you the latest copy of the code.  
+Before making changes, you'll want to ensure you have the latest copy of the code.  `svn up` (short for `svn update`) will get you the latest copy of the code.  
 
 {{{
@@ -43 +43 @@
 To remove files previously added, use `svn del`:
 
-`svn dell foo.pl`[[BR]]
+`svn del foo.pl`[[BR]]
 `svn del *.c`[[BR]]
 `svn del subdir`[[BR]]
@@ -49 +49 @@
 == Reviewing your changes ==
 
-To view information about what files have been changed, use `svn status`.  By default, it will display status on the current location in the repository, or you can specify a directory or file, or with no arguments
+To view information about what files have been changed, use `svn st`, short for `svn status`.  By default, it will display status on the current location in the repository; you can also specify a directory or file.
 
-*Tip:* Make sure you're in the right directory when you run this command.  For example, if you're working on package `foo`, but you're actually in `foo/bar`, it might not give an accurate listing of your changes to be committed.
+'''Tip:''' Make sure you're in the right directory when you run this command.  For example, if you're working on package `foo`, but you're actually in `foo/debian`, it will not display all your changes to the package
 
 Example:
 {{{
-joeuser@athena:~$ svn status
+joeuser@athena:~$ svn st
 A   foo.c
 M   bar.c
@@ -76 +76 @@
 == Committing your Changes ==
 
-Before committing, make sure your working copy is up to date with `svn update`.
+Before committing, make sure your working copy is up to date with `svn up`, and make sure you are in the right directory. Just like with `svn st` or `svn diff`, Subversion will only commit changes in the current working directory and below.
 
-You commit your changes with `svn commit`.  You can specify files to commit, or by default it will commit everything in the current working directory and subdirectories.  It's best to run `svn status` ahead of time to verify what will be changed.  You'll also want to specify a commit message with "-m".  Commit messages should be descriptive, but concise.  Don't mention what files have changed, the commit log will tell other users that.  Instead, say what you actually did.  Example:
+You commit your changes with `svn commit`, or for short, `svn ci` (for "checkin").  You can specify files to commit, or by default it will commit everything in the current working directory and subdirectories.  It's best to run `svn status` ahead of time to verify what will be changed.  You'll also want to specify a commit message with "-m".  Commit messages should be descriptive, but concise.  Don't mention what files have changed, the commit log will tell other users that.  Instead, say what you actually did.  Example:
 
 `svn commit -m 'Fixed a string-handling bug in bar.c'`
 
-If you are in the root directory of a package, and have added a new Changelog entry to `debian/changelog`, you can leave the commit message blank, and the Subversion server will use the contents of the new Changelog entry as the commit message:
+If you are in the root directory of a package, and have added a new changelog entry to `debian/changelog`, you should leave the commit message blank. The Athena repository is configured such that the added changelog entry will become your commit message:
 
 `svn commit -m ''`[[BR]]