Difference between revisions of "Brief introduction to SVN"

From Gramps
Jump to: navigation, search
(Run the development version)
Line 95: Line 95:
An alternative to the command line tools to view the svn repository is
An alternative to the command line tools to view the svn repository is
the [http://gramps.svn.sourceforge.net/viewvc/gramps/ online interface].
the [http://gramps.svn.sourceforge.net/viewvc/gramps/ online interface].
== Official committing policies ==
;Adding new files:All the files with the translatable strings '''must''' be listed in the po/POTFILES.in file. This means that most new files must have their names added to that file.
:All the files that need to be released '''must''' be listed in the Makefile.am in the same directory. Please remember to do this for new files that you add to SVN.
:You'll also need to set several properties for new files.  For .py files, try the following:
svn propset svn:mime-type text/plain src/somefile.py
svn propset svn:eol-style native src/somefile.py
svn propset svn:keywords 'Id' src/somefile.py
;Bugfixes in branches:Whenever a bug is fixed in a branch, it should be the committer's responsibility to make sure the fix is also committed to the trunk.
:You can do this manually, but you can also create a patch on gramps22 branch and apply it to trunk:
gramps22$  svn diff -r PREV > ~/mypatch.patch
gramps22$  cd ../trunk
trunk$  patch -p0 < ~/mypatch.patch
:Then you may have to fix things that could not be applied due to conflicts. The patch program would mark the conflicts with the <<<<<<, ======, and >>>>>> signs. You will then need to commit your changes:
trunk$  ./svnci
:More info: http://svnbook.red-bean.com/
;ChangeLog entries:Every change to the code should be documented in the top-level ChangeLog file (or in per-directory ChangeLog for po and help directories). When possible, we'd like to stick to the [http://www.gnu.org/prep/standards/html_node/Change-Logs.html GNU ChangeLog standards].
:This especially goes for committing contributed code. In that case, the ChangeLog should list the contributor's name and email, not the maintainer's.

Revision as of 03:12, 10 March 2008

The development source of GRAMPS is stored in the SVN repository. This helps synchronizing changes from various developers, tracking changes, managing releases, etc. If you are reading this, you probably want to do just two things with SVN: download latest source or the development version, or upload your changes.

Stable version 2.2.x

  • To download the source to a /home/~user/gramps22 directory, you can use two methods to access the SVN repository:
  1. An http frontend to gramps SVN
  2. SVN access
  • To upload your changes, you have to have developer access.

The second method requires that svn be installed on your system (Debian/Ubuntu: apt-get install subversion; Fedora: yum install subversion). With the SVN method, type the following in the command line:

  svn co https://gramps.svn.sourceforge.net/svnroot/gramps/branches/gramps22 gramps22

You should see the downloading progress reported in your terminal. If you would like to update your source tree after some time, execute the following command in the top directory of the gramps22 source tree:

  svn update

To commit your changes, you can execute:

  svn commit

Since uploading is a potentially dangerous operation, you have to explicitly obtain a write access to the SVN repository from Don Allingham or Alex Roitman.

Unstable development version 3.0

Also see: Running a development version of Gramps, and Getting Started with GRAMPS 3


  • 2008-01-16: a first beta has been released as a downloadable package, see sourceforge unstable. Use at own risk

If you want the latest and greatest, you can obtain the version from SVN too, see below.

Obtain it

As of 02 Feb 2007, a development branch has been created, which is now the new trunk. To grab a copy to ./gramps30 :

  svn co https://gramps.svn.sourceforge.net/svnroot/gramps/trunk gramps30

Prepare it

Now go into the gramps30 directory and type


You will get warnings of missing packages that GRAMPS needs to build from source. The most common warnings are, that you miss the gnome-common package if you run under Linux and Gnome. If you run Ubuntu install via Synaptic the 'gnome-common' (version 2.20.0-0ubuntu1): common scripts and macros to develop with GNOME: gnome-common is an extension to autoconf, automake and libtool for the GNOME environment and GNOME using applications. Included are gnome-autogen.sh and several macros to help in both GNOME and GNOME 2.0 source trees. Install these and/or any other missing packages, read INSTALL and README file in the gramps30 dir for pointers. An important library is also libglib2.0-dev. Check whether your system has this package installed. This will execute the make command too. If not, type after the above



Do not install the development version. That is, do not type sudo make install.

Run the development version

As you should not install the development version, how can you try it out? Easy, just type the following in the gramps30 directory

python src/gramps.py


Do not open your existing databases with gramps 3.0, it might destroy your data, and will make it impossible to use the data in the stable version 2.2.x. To try it out, export your database to a gramps xml file, eg test_version_3.0.gramps, create a new family tree in GRAMPS 3.0, and import this xml file.

Where for bugs?

The bug tracker has in the right top angle different projects. Choose project 3.x and submit an issue.

Useful things to know

Subversion commands

svn help add
svn help commit
svn help log

Adding files to repositories requires you to set some properties to the files. See svn help propset. You can use the propget on existing files to see how you should add it. A convenient way is to common files to your ~/.subversion/config file, eg in my config I have:

*.py = svn:eol-style=native;svn:mime-type=text/plain;svn:keywords=Author Date Id Revision
*.po = svn:eol-style=native;svn:mime-type=text/plain;svn:keywords=Author Date Id Revision
*.sh = svn:eol-style=native;svn:executable
Makefile = svn:eol-style=native
*.png = svn:mime-type=application/octet-stream
*.svg = svn:eol-style=native;svn:mime-type=text/plain

The svnci script

A usefull script for helping you commit changes is svnci: Download svnci


  • place svnci in your root svn directory, eg gramps22 or gramps30 (chmod +x)
  • you need to have the patchutils package installed, or svnci will throw an error (filterdiff is needed)
  • do edits and commit new files
  • edit the Changelog file with your edits
  • to commit changes to the svn repository, go to the root directory, and do ./svnci. This will collect all changes, and upload the change. The log message will be taken from the Changelog.

Browse svn

An alternative to the command line tools to view the svn repository is the online interface.