This page provides instructions on how to use SVN for the Physics of the B Factories Book project

Basic SVN Commands

Checking out the repository

The first step in using SVN for the book is to check out the repository using

svn checkout file:///nfs/slac/g/bflb/svn/Book/trunk 
which will checkout the trunk of the repository. Within the trunk you will find the tex files and sub-directories of the book. If you want to list the files that will be checked out, before you run the svn checkout command, you can do so with
svn list file:///nfs/slac/g/bflb/svn/Book/trunk

Updating to the trunk

Before committing any changes to svn, please always pull updates out of the trunk so that your local version is brought up-to-date. Any conflicts should then be resolved before committing files back to the repository. You can update your version of the trunk using

svn update
and you can check for differences between your version and the trunk using
svn diff
In addition to this, it is possible to use
svn status -u
This command will show the files changed on repository, and the action needed to update them on your local version. This can help you, by predicting conflicts.

Adding files

In order to add a file to the book, you will need to issue an add command prior to committing. For example

svn add YourSectionDir/YourNewFile.ext

Commiting back to the repository

After you have done an svn update and resolved any conflicts with the trunk, you can commit your modifications to SVN using

svn commit -m 'some useful comment'

Remote computing access

As discussed on the hypernews, it is possible to use SVN remotely by adding svn+ssh when checking out the repository. You will still require a SLAC account in order to checkout/commit files from/to the repository. For example to checkout the trunk of the book, one would use the command:

svn co svn+ssh://your-login@yakut16.slac.stanford.edu/nfs/slac/g/bflb/svn/Book/trunk 

More information

There are a number of good pages describing SVN in more detail. If you are interested in finding out more, or looking for functionality that is not covered here, please take a look at http://svnbook.red-bean.com/, and at http://www.wzdftpd.net/wiki/index.php/Subversion_Howto.

Tags

Tags are made on a daily basis, and are located in the Book/tags/ directory. The full list of tags can be found at http://www.slac.stanford.edu/xorg/BFLB/taglist.txt, where each daily tag uses the naming scheme YYYYMMMDD.

Compiling the LaTeX

There are several scripts that have been provided to help compile the latex into a readable pdf file. These can be used at the following levels:

Return to the The Physics of the B Factories Book home page.