Working with SVN
[I find the main GRASS website SVN help pages many, complex, and confusing. So trying to start over here with a more concise help page]
SVN Overview
Collaborative source code management using CVS or Subversion (SVN) keeps track of source code changes in a central spot and handles all the accounting work needed to cleanly handle version numbers and change history.
A SVN repository contains a trunk (aka HEAD), branches, and tags.
What are branches and tags?
SVN (the collaborative source code repository and tracking system we use) is broken down into three distinct parts: repositories, branches, and tags.
http://trac.osgeo.org/grass/browser/grass/
1. trunk. contains all source code and history for a project. aka HEAD
- for example grass (for grass 5.x), grass6 (grass 6.x),
2. branches. at a certain date it is split off from HEAD. New developement in HEAD will not appear in the branch, changes must be backported to the branch. Usually created in advance of a stable release to separate code that is trying to be stabilized from new development.
- for example releasebranch_6_0 or releasebranch_6_2 in the grass6 repository for GRASS 6.0.x and GRASS 6.2.x
3. tag. a branch snapshot, technically an alias to a date stamp in a branch
- for example release_20071127_grass_6_2_3 in the releasebranch_6_2 branch for the GRASS 6.2.3 release
4. also the GRASS Web site pages are managed in SVN: http://trac.osgeo.org/grass/browser/grass-web
5. also the GRASS Addons are managed in SVN: http://trac.osgeo.org/grass/browser/grass-addons
Implementation
The general principle is that no new development occurs on a release branch.
Development occurs on a development branch (or the trunk). When it is deemed time for a new series of releases, a the development branch is forked to create a release branch, and a snapshot of the release branch is created to form the first release candidate. Thereafter, the only modifications to the release branch are made by merging specific changes from the development branch to the release branch. The various release candidates and releases are snapshots of the release branch.
This means that changes whose desirability is uncertain can be made to the development branch. If they work out, they get merged onto the release branch. If they don't work out, they simply don't get merged; there is no need to explicitly back them out to obtain a stable version for release.
Tips for everyone
- Explore the SVN tree and file history with the Web interface.
Setting it up (first time)
- Download latest source code snapshot
wget http://grass.osgeo.org/grass64/source/snapshot/grass-6.4.svn_src_snapshot_${DATE}.tar.gz
- move it somewhere on your filesystem without spaces or special characters in the path.
mv grass-6.4.svn_src_snapshot_${DATE}.tar.gz /usr/local/src/
- decomress it
tar xzf grass-6.4.svn_src_snapshot_${DATE}.tar.gz
- at this stage, you may want to rename the source directory to something shorter
mv grass-6.4.svn_src_snapshot_${DATE}/ grass64svn/
cd grass64svn/
- update to the latest code
svn update
Updating entire source tree (another time)
For future updates, do:
- clear away the existing rubble (recommended if lib/gis/ changed)
make distclean
- update
svn update
- re run ./configure and make
Updating just one module
Often you are interested in just a single bugfix or updated module. Assuming the change didn't affect libraries or the build system, you can just update and recompile the code in the module's directory.
- for example, updating just the r.cost module
cd raster/r.cost svn up make
(and 'make install' in the main directory if you always install the software)
- If includes/ or module header files (*.h) have changed, you will have to run
make clean
before "make".
Tips for users wanting to contributing code
Code Standards
See these files in the source code. To keep the GRASS source code manageable, all new code must conform.
- SUBMITTING
- SUBMITTING_SCRIPTS
- SUBMITTING_TCLTK
- SUBMITTING_PYTHON
- SUBMITTING_DOCS
Legal issues
Copyright
- The developer may keep copyright on submitted code
- You must include copyright and licensing information in the header comments of your code so that others may know how they can use, extend, modify, and redistribute your work.
- The developer is encouraged to assign co-copyright to the GRASS Development Team. This gives the GRASS project flexibility over the source code, without this the Team must contact all former developers before allowing a license change (eg a legal hole is found in the GPL and the project needs to migrate to a new version) or confirming the original license. In a 20+ year old project, with often only a name and old email to go by, this becomes unworkable.
Example
at the top of a shell script:
#!/bin/sh ############################################################################ # # MODULE: v.in.e00 # # AUTHOR(S): Markus Neteler, Otto Dassau # # PURPOSE: Import E00 data into a GRASS vector map # Imports single and split E00 files (.e00, .e01, .e02 ...) # # COPYRIGHT: (c) 2004, 2005 GRASS Development Team and GDF Hannover bR, http://www.gdf-hannover.de # # This program is free software under the GNU General Public # License (>=v2). Read the file COPYING that comes with GRASS # for details. # #############################################################################
Licensing
- GRASS uses the GNU General Public License (the GPL).
Due diligence
Code submission method
(Note: this applies to people without SVN write access)
Be sure to develop on top of the LATEST GRASS code (SVN HEAD), not on top of a stable branch.
You can re-check before submission with:
svn diff
Preparing a patch
- See the wiki page describing Patches.
- Create a Unidiff patch against the latest development branch SVN (trunk).
Be sure to create them in unified ("diff -u") format. "Plain" diffs (the default format) are risky, because they will apply without warning to code which has been substantially changed; they are also harder to read than unified. The default for 'svn diff' is to create a unidiff.
Such diffs should be made from the top-level directory, e.g. "svn diff display/d.vect/main.c"; that way, the diff will include the pathname rather than just the generic "main.c".
Imagine that You have hacked around in module r.foo. To create a patch you should use following commands:
cd /path/to/grass7 svn diff raster/r.foo > r.foo.patch
Applying someone else patch
To apply patch created by someone else using "svn diff" command, You need to use following command:
cd /path/to/grass7 patch -p0 < /path/to/r.foo.patch
Creating a GEM package
The GEM system makes it easy to prepare intergrated add-on modules or groups of add-on modules as extensions to the existing GRASS source code. Users do not need to build the entire GRASS source package to add and build GEM packages.
- gem/index documentation
Submitting it to the Wiki Add-Ons page
The Add-ons page contains user contributed code which is not intended to go into the main GRASS source tree or is still experimental
- The GRASS AddOns page
Submitting it to the code tracker
Non-trival formal patches which are expected to become part of the main GRASS source tree should be uploaded to the "code patches" tracker and GRASS's trac site.
Announcing it on the GRASS Development mailing list
Once it is uploaded to the Wiki AddOns page or the trac code tracker, announce it on the GRASS-dev mailing list.
Final products added to the Wiki Add-Ons page should be announced on the GRASS users' mailing list.
Getting help
- IRC - Internet Relay Chat
- GRASS-dev mailing list
Tips for GRASS developers
(SVN write access, committing)
Becoming a GRASS developer
The GRASS Project Steering Committee is in charge of giving new developers write access to the CVS. This generally happens after the developer has been submitting code for long enough for the other developers to become familiar with the person and their coding ability.
Read on here: http://trac.osgeo.org/grass/wiki/HowToContribute
Responsibilities
Setting it up
- Connection to SVN with write access: see here
- configuring GRASS for code development:
- Linux: please use these flags to configure GRASS, they will help you to catch most programming problems:
MYCFLAGS="-g -Wall -Werror-implicit-function-declaration -fno-common"
MYCXXFLAGS="-g -Wall"
CFLAGS="$MYCFLAGS" CXXFLAGS="$MYCXXFLAGS" ./configure ... (more flags and parameters)
- MacOSX:
- MS-Windows:
Commiting
- work against latest development SVN HEAD (update before committing)
- code must compile
- verify changes with 'svn diff' before all commits
- cvs commit: make the svn log message a useful synopsis of the change (svn2cl script)
- double check the change using the live WebSVN interface or grass-qa mailing list