Subversion

From GnuCash
Revision as of 00:22, 18 November 2010 by Fell (talk | contribs) (SVN write access: send patches better to bugzilla)
Jump to: navigation, search

Our source code is hosted on the Subversion server svn.gnucash.org. For accessing the repository, you can choose many methods. The most direct method is using subversion as a client (also called svn). This is explained on this page.

Alternatively, you can use git as a method of accessing the source code. Or you can use svn-svk (FIXME: please add link here).

There is also a branch available via bazaar which is very quick to check out.

Repository URLs

The various base URLs look like:

 anonymous:  http://svn.gnucash.org/repo/gnucash/trunk
 developer:  svn+ssh://username@svn.gnucash.org/repo/gnucash/trunk
      trac:  http://svn.gnucash.org/trac

Note: If you are having problems with the http:// anonymous access, make sure your subversion is compiled with neon support.

Note: If you are behind a proxy (http firewall), you need to manually set the proxy name and authentication information in one of your local svn configuration file, namely in $HOME/.subversion/servers . Just open that file with a text editor and scroll to the end; you will find instructions there on how to set the variables. See also http://subversion.tigris.org/faq.html#proxy

Common Commands

To get what used to be CVS HEAD, you will need to get the svn TRUNK:

   svn checkout http://svn.gnucash.org/repo/gnucash/trunk gnucash

The argument "gnucash" above can be whatever you want your local directory to be called, and is optional. If you leave it out, you'll have a directory called "trunk" created containing all the source code.

If you want the latest 2.2.x code, you'd need to pull from the 2.2 branch, as follows:

   svn checkout http://svn.gnucash.org/repo/gnucash/branches/2.2 gnucash-2.2

And if you want the released code for a specific release (or tag), you'd use:

   svn checkout http://svn.gnucash.org/repo/gnucash/tags/1.8.12 gnucash-1.8.12

And to update, just cd into the directory containing the sources you want updated and execute a simple

   svn update

To switch a TRUNK working copy to the 2.2 branch, cd into the directory containing the sources you want updated and do this:

   svn switch http://svn.gnucash.org/repo/gnucash/branches/2.2

You probably want to continue reading at the Building page. Otherwise, continue on below for information on how to use subversion.

SVN tutorial

Now that the gnucash repository is using svn for version control (since 2005-11-04), the need for a quick tutorial on how to get the sources might be in order. There was some introduction about SVN in an e-mail on gnucash-devel:

The excellent "Version Control with Subversion is a very good resource for information about subversion.

Specifically, Chapter 3. Guided Tour and Appendix A. Subversion for CVS Users are relevant.

The command-line client `svn` has a nice integrated help system; `svn help` will provide the top-level command list, and `svn help <command>` detailed help for the specific command.

The bottom line is that getting the source via svn isn't altogether different from getting it using cvs.

CVS to SVN cross reference

CVS command SVN command Notes
cvs checkout svn checkout
cvs commit svn commit
cvs status svn status ...but the svn one is actually useful :)
cvs log svn log
cvs annotate svn blame
cvs diff svn diff
cvs diff -D 2006-01-01 svn diff -r {2006-01-01}:HEAD
cvs update svn update, svn switch
cvs update -C svn revert
cvs update -j [...] svn merge
---- svn resolved [conflicting merges must be explicitly resolved]
cvs add svn add, svn mkdir
cvs remove svn delete
---- svn move
cvs [r]tag [-b] svn copy


Enjoy!

Maintain a local copy of the repository

Note: For keeping track of the various branches in SVN and have patch creation made much much easier, it might be very helpful to use one of the many tools to maintain a local copy of the SVN repository. Some of these options are:

SVN write access

FAQ: Is it possible to get SVN write access?

A: In principle yes, but we are quite conservative with giving out new SVN write accounts. For occasional changes people are encouraged to submit patches. We do add people as developers if they stick around, supply lots of patches, become highly involved in the project, hang out on IRC, and generally show some level of clue and prove some level of trust. But in the meantime, patches in email are the suggested route, as has been stated at other places. --Cstim 08:00, 8 January 2006 (EST)

Meanwhile it turned out as the best way, to attach your patch to an bugzilla entry as it then will not forgotten.


Other options exists as well; feel free to edit this wiki page.

Back to Development Process