Changes

{{man warn|{{man menu|Development has moved to using Git}} please read a [[Category:Developers/GeneralBrief introduction to Git]]|The development source code of GRAMPS is Gramps '''was''' stored in the SVN (Subversion) repositoryat sourceforge. 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.}}

;[http://svn.code.sf.net/p/gramps/code/ http://svn.code.sf.net/p/gramps/code/].  This helps synchronizing changes from various developers, tracking changes, managing releases, etc. If you are reading this, you probably want to do one of two things with SVN: either download the latest source or the development version, or else upload your changes (if you have write access to the repository) or [[Brief_introduction_to_SVN#Making_a_patchfile|make a patchfile]] (if you don't have write access). * All developers should read Gramps [[Committing policies]] == Stable Types of branches ==There are four kinds of branches in the Subversion Repository:  * ''trunk'' - There is only one trunk. All new feature development happens in the trunk. New releases never come from the trunk. The trunk for Gramps can be found here: http://svn.code.sf.net/p/gramps/code/trunk * ''maintenance'' - There are many maintenance branches. A maintenance branch is created from the trunk when all the features for a release are complete. New features are not committed to maintenance branch. Releases only come from maintenance branches. The purpose of maintenance branches is to allow the line of code to stabilize while new features are added in trunk. Maintenance branches can be found here: http://svn.code.sf.net/p/gramps/code/branches/maintenance * ''geps'' - These are meant for development of [[Portal:Enhancement_Proposals|Gramps Enhancement Proposals]]. Most of the time GEPS are developed in the ''trunk''. Occasionally a GEP will require extensive reworking or long periods when the code base is unusable. In these cases a branch in ''geps'' can be used as a temporary development area. Once the hard work is done the change should be merged into the trunk and the ''geps'' branch should be removed. ''greps'' branches should follow the naming convention ''gep-<###>-<descriptive text>'' e.g. ''gep-013-server''. Please read the [[#Working with development branches]] section for help with managing these branches. * ''sandbox'' - These are meant for experimentation purposes. If you want to explore some ideas or try out some changes that would break the ''trunk'' or prototype something that has not made it to a GEP you can create a ''sandbox'' branch. These should be short lived. As soon as you have finished please remove the branch. We reserve the right to remove any ''sandbox'' branch that has not been touched for 12 months. ''sandbox'' branches should use the following naming convention ''<username>-<descriptive text>'' e.g. ''hippy-prototype-rss-idea''. Please read the [[#Working with development branches]] section for help with managing these branches. Release tags are created in the ''tags'' directory. The first two digits of the Gramps version number are reserved to indicate the maintenance branch the code came from. The last digit indicates the revision from that maintenance branch. For example, 3.0.4 would indicate the 5th release from the 3.0 branch (3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.0.4). Here is a hypothetical example:Imagine that the current version of Gramps is 8.3.2.x A new series of features has been added in trunk and are ready for release. A new maintenance branch is created from trunk named 8.4 (or possibly 9.0 depending on the nature of the new features). New features continue to be added in trunk that will not be included in the 8.4 series of releases, but will be included in the 8.5 series. Bug fixes continue to occur in the 8.4 branch until the code is deemed worthy of release. At that time, a release is tagged from the 8.4 maintenance branch and named 8.4.0. Some time after the release of 8.4.0, some bugs are found and fixed in the 8.4 maintenance branch. Those bug fixes are released as 8.4.1. == Stable version ==* To download the source to a /home/~user/gramps22 gramps41 directory, you can use two methods to access the SVN repository:

With the SVN method, type the following in the command lineif you '''don't have a sourceforge account''':  <code>svn co <nowiki>http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps</nowiki>41 gramps41</code>  You should see the downloading progress reported in your terminal. If you have a sourceforge account, use https instead: <code>svn co <nowiki>https://grampssvn.svncode.sourceforgesf.net/svnrootp/gramps/code/branches/gramps22 gramps22maintenance/gramps</nowiki>41 gramps41</code> You will in this case be requested for your root keyring password which will store your sourceforge credentials, and next your password. If the user on your PC is not the same one as on sourceforge, leave password empty and press enter, you will then receive the option to enter a username first, and then the sourceforge password for that username.

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 gramps41 source tree:

<code> svn update</code>

To commit your changes, you need to have checked out the gramps code with https, and have commit access to the Gramps repository (the Gramps admin can give you this, [[Contact|Brian Matherly or Benny Malengier]]). Commit happens if execute:

<code>svn commit -m "message describing the nature of the change"</code>  svn Since uploading is a potentially dangerous operation, most people do not obtain write access to the SVN repository. In this case, create a patch, and committhis on the [http://bugs.gramps-project.org ticket tracker]. You can do this in the top gramps directory as follows: <code>svn diff > mychanges.patch</code> A developer can apply this patch then with the command:

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<code>patch -p0 < mychanges.patch</code>

== Unstable development version 3.0 : "trunk" ==

:Also see: [[Running a development version of Getting started with GrampsTrunk]].

As There are several versions of 02 Feb 2007, a the gramps code in SVN. The development branch for small changes and bug fixes is ''gramps41'' and ''trunk'' has been created, which is now for the new ongoing unstable version.  If this talk of ''branch'' and ''trunk'' sounds confusing you might like to read the list message [http://sourceforge.net/mailarchive/message.php?msg_id=19238907 explaining branch and trunk]. '''Replace in the commands here ''https'' by ''http'' if you do not have a sourceforge account.  To grab checkout a copy of the possibly unstable trunk to ./trunk: <code>svn co <nowiki>https://svn.code.sf.net/p/gramps/code/trunk trunk</nowiki></code> To checkout a copy of the last branch Gramps 4.0 ./gramps40: <code>svn co <nowiki>https://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps40 gramps40</nowiki></code> To checkout a copy of the last branch Gramps 3.4 ./gramps34: <code>svn co <nowiki>https://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps34 gramps34</nowiki></code> To checkout a copy of the last branch Gramps 3.3 ./gramps33: <code>svn co <nowiki>https://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps33 gramps33</nowiki></code> To checkout a copy of the last branch Gramps 3.2 ./gramps32: <code>svn co <nowiki>https://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps32 gramps32</nowiki></code> To checkout a copy of the last branch Gramps 3.1 ./gramps31: <code>svn co <nowiki>https://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps31 gramps31</nowiki></code> To checkout a copy of the older stable Gramps 3.0 ./gramps30: <code>svn co <nowiki>https://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps30 gramps30</nowiki></code> To checkout a copy of the older stable Gramps 2.2 ./gramps22: <code>svn co <nowiki>https://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps22 gramps22</nowiki></code> === Prepare gramps40 and trunk ===Now go into the <code>trunk</code> directory and type python setup.py build {{man warn|1=Warning|2=Do not install the development version if you don't know how to version python modules. That is, do '''not''' type {{man label|sudo python setup.py install}}. }} === Prepare gramps34 and before===The old versions of Gramps use autotools, so you need to run ./autogen.sh make ==== Building with Fedora 8 - 10 ==== These are the packages you need: 

{|style="width:80%;margin-top:+.7em;margin-bottom:+.7em;background-color: #c0f0ff;border:1px solid #ccc; padding: 5px" align="center"== Windows ====|-|This step appears unnecessary on windows? See [[Image:Gnome-important.pngInstallation#Building_from_source]]|<center style="font-size:110%">Do not install the development version. That is, do '''not''' type <code>make install</code></center>|}

As you should not install the development version, how can you try it out? The current Python version required to run Gramps trunk is officially python2.7 as of July 2012.  {{man note|1=Known Problems|2=Some problems are due to the migration from GTK2 to GTK3: [[GEPS_029:_GTK3-GObject_introspection_Conversion#Problems|list of known problems]]}} ==== Option 1: run from source repo ====EasyHere, we use the code in <code>trunk</code> directory to run Gramps. This means that compiled python files will be stored there. This is not ideal, but the easiest way to develop Gramps, just type as changes are immediately picked up by the code. Copy the const.py file created in build to your source directory if you want to use your source directory to work with Gramps: cp build/lib.linux-$(uname -m)-2.7/gramps/gen/const.py gramps/gen/const.py python Gramps.py ''Note'': the <code>lib.linux-$(uname -m)-2.7</code> folder name vary depending on your system (i686 or x86_64). That is it. If you installed some dependencies of Gramps in non-default positions, you need to indicate with PYTHONPATH where they can be found, and with LD_LIBRARY_PATH where link libraries can be found. Eg, if you install GTK and spell checking from source too, you will need something like: PYTHONPATH=/usr/local/lib/python2.7/site-packages/ LD_LIBRARY_PATH=/usr/local/lib python Gramps.py ==== Option 2: use the build code ====Here, we use the following code build in <code>trunk/build</code> directory to run Gramps. For compiled programs this is the only way, but for Gramps nothing is compiled. It is not bad however to keep your code separated from your execution, as deleting the build directory is easy. After a code change in your source, you then need to run however <code>gramps30python setup.py</code> again to update the build direcotry. To run Gramps from build, do cd trunk/build/lib.linux-$(uname -m)-2.7/ python -c 'from gramps.grampsapp import main; main()' Again, it might be needed to set with PYTHONPATH where dependencies can be found, and with LD_LIBRARY_PATH link libraries, see option 1. If you point your PYTHONPATH to the build directory, you can actually run Gramps from a random directory. Like this:  cd PYTHONPATH=~/gramps-trunk/build/lib.linux-$(uname -m)-2.7/ python src-c 'from gramps.grampsapp import main; main()' So, more general: cd PYTHONPATH=~/gramps-trunk/build/lib.linux-$(uname -m)-2.7/:/usr/local/lib/python2.7/site-packages/ LD_LIBRARY_PATH=/usr/local/lib python -c 'from gramps.grampsapp import main; main()' If the build directory is in your PYTHONPATH, you can also just execute the grampsapp.py module. So this will work too: cd ~/gramps-trunk/build/lib.linux-$(uname -m)-2.7/gramps PYTHONPATH=~/gramps-trunk/build/lib.linux-$(uname -m)-2.7/ python grampsapp.py or again more generally PYTHONPATH=~/gramps-trunk/build/lib.linux-$(uname -m)-2.7/:/usr/local/lib/python2.7/site-packages/ LD_LIBRARY_PATH=/usr/local/lib python grampsapp.py '''Note''': At the time of writing, only the last, so using grampsapp.py works, as not all imports in Gramps have been converted to relative or absolute imports. This conversion will be finished by end of 2012 however. 

{{man warn|style1="width:80%;margin-top:+.7em;margin-bottom:+.7em;background-color: #c0f0ff;border:1px solid #ccc; padding: 5px" align="center"warning|-|[[Image:Gnome-important.png]]|<center style2="font-size:110%">Do not open your existing databases with gramps 3.0trunk, it might destroy your data, and will make it impossible to use the data in the stable version 2.2.x{{stable_branch}}. To try it out, export your database to a gramps xml file, eg <code>test_version_3.0test_trunk.gramps</code>, create a new family tree in GRAMPS 3.0trunk, and import this xml file.</center>|}}

The [http://bugs.gramps-project.org bug tracker] has in the right top angle different projects. Choose project 3.x ''trunk'' and submit an issue. === Making a patchfile ===If you do not have write access to the repository, you can make a patchfile with your changes. This is a text file which can then be sent by email to somebody, or posted/uploaded to the bug tracker (against a bug you are fixing or a feature request which you are solving for instance), etc. These instructions assume SVN is installed on your system (Debian/Ubuntu: <code>apt-get install subversion</code>; Fedora: <code>yum install subversion</code>). These instructions tell how to make a patchfile against trunk, so that your changes are added to the next major release of Gramps. (To make a patchfile against a branch the process is similar, with some slight changes.) So first checkout a copy of the trunk to ./trunk:  svn co <nowiki>https://svn.code.sf.net/p/gramps/code/trunk trunk</nowiki> Then use your favorite editor to change whatever file(s) you want. To then use SVN to make a patchfile, first go to the top of your changed tree  cd /path-to-your-gramps/trunk and then tell SVN to record/document/itemize the changes to your edited file(s)  svn diff > ~/some-descriptive-name.patch with the resulting file being the patchfile you just made. If you want to add a new text file, such as a new python module,you can include that in your patchfile by first doing, e.g.,  svn add dir1/dir2/newfile.py before you do the "svn diff" as described above. (This methoddoes not work for non-text files such as image files; be warned.) Note also that if you add a file in this manner, dependingon what was added and where it was added, you may also haveto modify the corresponding Makefile.am file. (Who is I? - I do not know how to make a patchfile which documentsa deleted file which "patch" will then correctly delete.(If you know how, please add it here.) When SVN version 1.7is released (scheduled for 1Q2011 as I write this), then therewill be a "svn patch" command which should do that. (Pat SVN 1.7 is out this is the link talk about [http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.patch.html]) == Working with development branches ==  If you are using a ''geps'' or ''sandbox'' branch you need to take care when merging changes from the ''trunk'' and back to the ''trunk''. Please take a few minutes to read the [http://svnbook.red-bean.com/en/1.5/svn.branchmerge.basicmerging.html| Basic Merging] section of the Subversion book.  '''IMPORTANT:''' please use an svn client that is version 1.5 or newer. The merge tracking functionality only became available in 1.5. If you use an earlier client you will have to deal with all the revision tracking of merges by hand - not fun. '''IMPORTANT:''' if you see a message that talks about ''from foreign repository'' it is probably because your working copy was checked out from an http:// url but you are merging from a https:// url or visa versa. Just be consistent about why you use. Don't merge ''from foreign repository'' because svn will not be able to manage the revisions correctly. Here is a quick crib sheet: === Creating a branch === To create a branch from the ''trunk'':  svn copy <nowiki>https://svn.code.sf.net/p/gramps/code/trunk https://svn.code.sf.net/p/gramps/code/branches/geps/gep-014-fab-feature</nowiki> === Merging ''trunk'' changes into the branch === You should do this regularly so that you don't have a nasty job of resolving loads of conflicts when you come to merge your changes back into the ''trunk'':  cd gep-014-fab-feature svn merge <nowiki>https://svn.code.sf.net/p/gramps/code/trunk</nowiki> '''NOTE''' you will see some modification to files that you are not expecting. If you look at these you will find that they are modifications to svn properties. These are used by the merging tool to keep track of what changes have already been applied. === Merging changes from the ''branch'' back into the ''trunk'' === When you are ready to merge your changes back into the ''trunk'': First make sure you have all the ''trunk'' changes in your branch:  cd gep-014-fab-feature svn merge <nowiki>https://svn.code.sf.net/p/gramps/code/trunk</nowiki> svn commit -m "meaningful message" Then move over to a working copy of the ''trunk'' and merge in your branch:  cd trunk svn merge --reintegrate <nowiki>https://svn.code.sf.net/p/gramps/code/branches/geps/gep-014-fab-feature</nowiki> Now build it, test it, convince yourself that it all works and then commit the changes:  svn commit -m "All the changes for GEP-014" Now you '''must''' delete your branch. You can recreate it later if you need to but svn can not cope with doing another merge --reintegrate from the same branch:  svn remove <nowiki>https://svn.code.sf.net/p/gramps/code/branches/geps/gep-014-fab-feature</nowiki> === Removing branches === It is important that branches are removed once they have been merged into the trunk or have been abandoned. To remove a branch:  svn remove <nowiki>https://svn.code.sf.net/p/gramps/code/branches/geps/gep-014-fab-feature</nowiki> The developers reserve the right to remove branches that have been dormant for more than 1 year.

Adding files to repositories requires you to set some properties to the filesand to have a [http://apps.sourceforge.net/trac/sitedocs/wiki/Subversion sourceforge account]. See <code>svn help propset</code>. You can use the <code>propget</code> on existing files to see how you should add it. A convenient way is to add common files to your <code>~/.subversion/config</code> file, eg in my config I have:

=== The svnci script = Workflow ====Before switching to another branch it is useful to remove untracked files created by the build process. You can do this with the following commands in that branch directory[http://www.jukie.net/bart/blog/svn-clean]:  svn status --no-ignore | awk '{print $2}' | xargs rm -rf svn revert -R . svn update === Ignore files ===You should on creation of new directories set the svn:ignore property:  svn propedit svn:ignore src/new_dir/ and there set at least: *.pyc *.pyo Makefile Makefile.in === svn2cl ===The Gramps project does not keep a ChangeLog file under source control. All change history is captured by Subversion automatically when it is committed. A usefull script for helping ChangeLog file is generated from the SVN commit logs before each release using [[Brief_introduction_to_SVN#How_to_use_svn2cl|svn2cl]]. Developers should take care to make useful commit log messages when committing changes to Subversion. Here are some guidelines: *Try to make a descriptive message about the change.*Use complete sentences when possible.*When committing a change that fixes a bug on the tracker, use the bug's number and summary as the message.*When committing a patch from a contributor, put the contributor's name and e-mail address in the commit message.*It is not necessary to put the names of the files you have modified in the commit message because Subversion stores that automatically. ==== How to use svn2cl ==== Starting with Gramps 3.0.0, we no longer have a <tt>ChangeLog</tt> file.  Instead, the list of changes is generated automatically using the standard <tt>svn2cl</tt> script. Note that <tt>svn2cl</tt> is not included in the base installation of subversion. With a Debian-based distro such as Ubuntu, you can get <tt>svn2cl</tt> as follows:  sudo apt-get install subversion-toolsor sudo apt-get install svn2cl There typically are two <tt>ChangeLog</tt> files needed for releases; one in the main directory, and one in the <codett>svncipo</codett>directory. You can generate these files with the following commands: [[Media  cd gramps30 svn2cl --reparagraph --include-rev --authors=src/data/authors.xml cd po svn2cl --reparagraph --include-rev --authors=../src/data/authors.xml ===SVN Commit Tips======= Some procedural recommendations ==== # Always do ''svn up'' before a commit, and look especially for conflicts marked 'C'. If necessary get advice about handling conflicts.# Always do ''svn st'' and look for modifications 'M' that are unexpected or unintended. This is a *very important* sanity check. Checking the '?'reports for forgotten additions is also worth remembering.# Recommeded to explicitly name commit targets via 'svn ci X Y Z ..', but if you do simply 'svn ci' (or use a utility commit script), it is especially important to:## check advisory (2)## quit (no save) your edit session if you see a filename you did not expect -- svn will prompt whether you want to abort or commit without a log entry (say 'abort'). ;And here are a couple of incidental suggestions * avoid grouping unrelated changes; better to divide into separate commits for the following reasons:Svncia better log entry; easier troubleshooting/reverting. (and probably more). * similar to above, it may be better to make small incremental changes than one big one (if possible).tarInterim changes should not introduce breakage, of course.gz|Download svnci]]

Usage:*place svnci in your root svn directory, eg <code>gramps22</code> or <code>gramps30</code>*you '''need''' logs are important -- please give some thought to have the ''patchutils'' package installed, or svnci will throw an error (''filterdiff'' is needed)*do edits and commit new files*edit log message: the Changelog file with your edits*to commit changes to the svn repositoryideal first sentence would be short, go to the root directorymeaningful, and do <code>suggestive./svnci</code>Include a tracker issue #NNNN there, if appropriate. This will collect all changesAdditional explanation is encouraged if it would be something you yourself would appreciate when reading it six months from now. If relevant, and upload the emphasize impact of change. The log message will be taken from the Changeloguser's point of view.

=== Browse = svn merge ====

An alternative If you do a change in a branch, you need to do the command line tools to view same change in trunk. You can create a patch on the branch with svn repository isdiff > mypatch.patchand then apply the [http://grampssame patch on trunk.svn.sourceforge.net/viewvc/gramps/ online interface] patch -p0 < mypatch.patch

== Official committing policies ==;Adding new filesThere is a more convenient way though:All use svn merge. For this you commit your changes in the files with branch, and write down the translatable strings '''must''' be listed revision number, eg a commit in the po/POTFILESbranch{{stable_branch}} : Transmitting file data .. Committed revision 12345.Now you apply this change in file. This means that most new files must have their names added branch{{stable_branch}} to that filetrunk as follows.Go into your trunk working branch, and there type the command:

svn merge -c 12345 https:All the files that need to be released '''must''' be listed in the Makefile//svn.am in the same directorycode. Please remember to do this for new files that you add to SVNsf.net/p/gramps/code/branches/maintenance/gramps{{stable_branch}}

:You'll also need to set several properties for new files. For .py filesThe change will then be obtained and applied, 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 'Author Date Id Revision' src/somefileafter which you can commit trunk.py

:Then you may have to fix things that could not be applied due to conflicts. The patch program would mark the conflicts with the <<<<<<, ===Browse svn ===, and >>>>>> signs. You will then need to commit your changes: trunk$ ./svnci

:More info: An alternative to the command line tools to view the svn repository isthe [http://svnbooksourceforge.red-beannet/p/gramps/code/ online interface].com/

;ChangeLog entries==External links==*[http://subversion.apache.org/ Apache™ Subversion®]*[http:Every change to the code should be documented in the top-level ChangeLog file (or in per//svnbook.red-directory ChangeLog for po and help directories)bean. When possible, we'd like to stick to the com/ Version Control with Subversion]*[http://www.gnuclear.rice.org/prep/standardsedu/html_nodecomp314/Change-Logssvn.html GNU ChangeLog standardsSource control in ten minutes: a Subversion tutorial].

[[Category:This especially goes for committing contributed code. In that case, the ChangeLog should list the contributor's name and email, not the maintainer's.Developers/General|B]]