wiki:RevtreePlugin

Revision Graph for the Version Control Browser

Description

This plugin renders a graphical representation of the repository.

The plugin collects the repository's revisions and rebuilds the branches based on the names of the files changed in each revision.

Filters can be used to choose which branches and which revisions are to be displayed.

Each depicted changeset is a clickable item that redirects the browser to the appropriate changeset view.

Whenever the mouse cursor is hovered over a revtree changeset, the browser opens a tool tip box that shows the revision number, the author and the date of the revision along with the wiki-formatted log message.

The plugin also shows branch cloning/tagging operations, and can be extended to render other kinds of operations such as merging.

Changeset info tip
Changeset info tip

Overview

This plugin creates a graph that shows the changesets of the project repository.

Filters

The user may select which changesets are to be rendered, based on several filters:

  • The main filters are mutually exclusive:
    1. changeset range: this filter selects a range of changesets to be rendered
    2. time range: this filters selects the latest changesets of the repository, with the following predefined time ranges:
      • day, 2 days, 3 days, week, fortnight, month, 2 months, 3 months, year
  • Any of the following filters can be combined to the main filter to refine the selection:
    • branch name: this filter selects a single branch, along with all branches declared as 'trunks'
    • author: this filter selects all the branches for which the selected author has to be a participant (i.e. has committed at least one changeset)
    • show terminated branches: this filter makes all branches visible, including deleted ones. Default setting hides all terminated branches.

User preferences (filters)
User preferences (filters)

Two kinds of views can be selected:

  • compact: in this mode, the revtree graph is kept as compact as possible, in an attempt to make all the changesets visible on the web browser page and thereby minimize the scrolling actions. Changesets are placed along on their branch, irrespectively of the nearby branches.
  • timeline: in this mode, the revtree graph maintains a time view of the repository: each changeset can be seen relatively to the other changesets, whichever the changeset branch.
    See revtree-stresstest.png for a totally useless, gigantic sample image of the timeline mode with about 300 changesets.

Example

Revtree sample image (v0.6.0), w/ Firefox 3.0.1

User preference persistence

The plugin stores the user settings (filters) in the user session, so the latest configuration is used whenever the user selects the 'revtree' page.

In some cases, the chosen filters select no changeset hence no revtree graph can be rendered. In such an event, a Trac error is displayed with the following message:

Selected filters cannot render a revision tree

User settings are not saved if the filter does not permit to generate a valid revtree graph.

Limitations

There are a lot of limitations, so read them carefully.

RevtreePlugin assumes that each revision contains changes in a single branch - and only one.
If it's not the case, RevtreePlugin may not work, or behave badly.

See #1090 and #1191 for details about this design choice, as well as #1354 and #1635.

CVS switchers, please be sure to read the dedicated section

  1. the RevtreePlugin generates inlined SVG.
    • SVG is only supported on modern browsers
    • inlined SVG means that the plugin generates XHTML+SVG data, which are only supported by a few browsers. Many browsers that support SVG do not accept inlined SVG. Checkout the following section for a non-exhaustive list of supported browsers.
  2. the RevtreePlugin only works with SVN repositories
  3. it does not support SVN authz
  4. it has not been thought with multiple projects per repository in mind, so its support for this kind of configuration is probably weak
  5. filters do not support multiple selections: one can only select all or one branch, all or one author

See RevtreePlugin/Limitations for a technical 'discussion' about the current limitations.

The plugin output has been tested against the w3 validator and generates Valid XHTML 1.1 plus MathML 2.0 plus SVG 1.1.

Supported browsers

Any browser that supports inlined SVG should work. However, as it seems that some browsers are not able to cope with this kind of data, the following table sums up what you can expect from your favorite browser:

Sorry, RST support is broken on Trac Hacks for now. You can get the compatibility matrix from compatmatrix.txt.

The browser compatibility matrix has been created with RevtreePlugin 0.5.15 on April '08, 17th.

Installation

Trac requirement:

  • It depends on the plugin version you install. Please read the version requirement defined in setup.py file, search for install_requires

Get the plugin source code

Download

Download the zipped source from here.

Source

You can check out RevtreePlugin from here using Subversion, or browse the source with Trac.

Build the plugin

As with any other plugin:

python setup.py bdist_egg

Installation of the plugin

Copy the generated egg file (from the dist/ directory) to your project plugin directory, or in the global plugin directory if you want to use it for several Trac projects

Enabling the plugin

From the WebAdmin plugin interface or from your trac.ini file, enable the RevtreePlugin.

In trac.ini, edit the components section to add the revtree entry as follows:

[components]
revtree.* = enabled

Configuration

The revtree plugin can be configured with the help of the following settings:

  • Mandatory parameters defined in the Trac section
    [trac]
    # SVN repositories only
    repository_type = svn
    # Base URL is a required parameter: it should be defined
    base_url =
    
    Note: base_url should not be left blank: it should be defined to the actual Trac URL, see TracIni
  • Optional parameters defined in the revtree section
    [revtree]
    # regular expression for branch recognition 
    # (always define 2 named groups: 'branch' and 'path')
    branch_re = ^(?P<branch>branches/[^/]+|trunk|tags)(?:/(?P<path>.*))?$
    # space-separated list of branches that should be considered as 'trunks'
    trunks = trunk
    # SVG rendering scale (real number)
    scale = 1.0
    # oldest revision to consider (default to the latest revision in the repos)
    revbase = 1
    # whether time filters start on absolute time or on the time of the youngest revision
    abstime = True
    # default appearance (either 'compact' or 'timeline')
    style = compact
    # revtree item appears as the main menu
    contexts =
    

Some settings deserve additional information:

  • the style option defines the default revtree graph style. Each user overwrites the default style the first time they update the revtree style.
  • the reltime option cannot be customized by the users. The admin chooses whether the time filters are based on the absolute time or the youngest changeset in the repository. Let's say the youngest revision in the repository has been committed three days ago:
    1. if reltime is set, the revtree time starts three days ago as well: if the user selects the last 2 days as a filter, the last 5 days (3+2) will be shown
    2. if reltime is not set, the revtree time starts now: if the user selects the last 2 days, no changeset will be shown.

Repository layout adaptation

The default RevtreePlugin setting is defined to work with single-project repository layout, as defined in the Subversion book repository layout section.

If your repository follows a different layout, you need to tweak the branch regex.

The following regex would better match the multiple-project repository layout:

branch_re = ^(?P<branch>[^/]+/(?:(?:tags|branches)/[^/]+|trunk))(?:/(?P<path>.*))?$

Revtree menu item

Revtree menu may either appears as a main menu item (i.e. in the menu bar) or as a contextual menu item.

  • to make revtree link appear as a contextual menu item, define a contexts option in the [revtree] section of your trac.ini file and use a comma-separated list of the page contexts where the revtree menu should appear, e.g.
    [revtree]
    contexts = changeset, browser
    
    makes revtree links appear in the Changeset navigation bar and the Browser navigation bar:

Revtree as a contextual menu item

  • to revert to the default settings, that is make Revtree to appear within the main menu bar, simply remove the contexts option from your config file:

Revtree as a main menu item

Position in the main menu

You can change the position of the revtree menu item using the Trac mainnav setting, see TracIni.

For example, to make the revtree menu item appear at the right hand side of the browser item, update the mainnav line as follows:

[trac]
mainnav = wiki,timeline,roadmap,browser,revtree,tickets,newticket,search

Permissions

The RevtreePlugin defines a new permission REVTREE_VIEW. This permission should be defined for the 'revtree' link to appear in the main navigation bar, and to give access to the revtree feature.

Restarting trac

You need to restart your web server to make the changes effective.

Revision tree enhancements

The RevtreePlugin has been written with customization in mind: it provides extension points so that one can write his own plugin(s) to add information to the rendered graph and enhance it.

For now, there are two ways to enhance the revision tree graph:

  • Change the appearance of the rendered items, and add operations to the graph. An operation is a relation between two distinct branches, such as a merge operation.
    -> this extension point is dedicated to provide operations that are not maintained by the underlying repository. These operations can be stored in revision properties, log message, or any other way: it depends on how a team uses the repository.
  • Improve the branch placement. One of the most difficult tasks to draw a graphical representation of the repository is to find the best location for each branch. The best location depends on how a team works, what is the most important information to be represented, and to limit the number of operation intersections as much as possible.
    -> this extension point allows custom branch sorting. There are probably smart algorithms that could allow better branch placement.

Default enhancers

The RevtreePlugin comes with default enhancers:

  • SimpleEnhancer is a very basic enhancer that is only able to cope with branch creation and tagging.
  • It uses a dummy placement algorithm, which places the trunk at the center of the graph, and tries to reduce the number of operation intersections.

More enhancers

Enhancers based on log messages

  • the RevtreePlugin/LogEnhancer plugin is provided as an implementation example of the first kind of enhancer. It uses special keywords in the log messages to augment the revtree graph with branch creation, termination and merge operations.

Enhancers based on SVN properties

  • the RevtreePlugin/MergeInfoEnhancer plugin can be used with the latest SVN release (SVN >= 1.5) to show the inter-branch merge operations of a repository. It is in early development stage and may not be reliable.

  • the RevtreePlugin/MergeEnhancer plugin can be used in conjunction with the svnmerge tool to show the inter-branch merge operations of a repository. This enhancer is not actually maintained and is provided as an example of enhancer implementation

Miscelleanous

SVN repository imported from CVS

I never used cvs2svn myself, but the following information might be useful for those who want to import their CVS-managed source code into a new SVN repository, and still be able to browse the repository with the RevtreePlugin.

Thanks to Marcio Marchini for providing these tips:

It is perfectly possible to make cross-branch commits using CVS and Subversion, so by default when cvs2svn sees what looks like a CVS cross-branch commit, it converts it as a Subversion cross-branch commit.
But you can use a switch in the options file to choose different behavior. See the following section in cvs2svn-example.options:

# To prevent CVS commits from different projects from being merged
# into single SVN commits, change this option to False:
ctx.cross_project_commits = True

# To prevent CVS commits on different branches from being merged into
# single SVN commits, change this option to False:
ctx.cross_branch_commits = True

If you want to use your project with Revtree, you should set both of these options to False.

If you have already used your converted repository for a while, then you already have commits on top of the ones generated by cvs2svn and it would be very difficult to change your repository retroactively. It could possibly be done by re-converting with cvs2svn, "svnadmin dump"ing the post-conversion commits to a dumpfile, hacking the dumpfile to fix the revision numbers that it refers to, then "svnadmin load"ing the dumpfile onto the newly-converted repository.

Anyway, it seems that cvs2svn enclines to generate changesets that Subversion APIs fail to describe properly. See #1638.

Recent Changes

See RevtreePlugin/Changelog

Since version 0.6.0, the plugin is able to process the tags as label instead of regular branch. The documentation for this new feature is yet to be written, and this feature introduces compatiblity breaks for the Enhancers. It is highly recommended to read the changelog for details.

Since version 0.5.0, only Trac 0.11 is supported.
Previous releases are still available for download, but are no longer maintained.

Version 0.5.0 and above cannot be used with Trac 0.10 as it requires the Genshi library and uses Trac internal APIs that have changed since the previous release.

Additional notes

Do not forget to flush your browser cache when you update the RevtreePlugin. Several browsers fail to reload CSS and/or Javascript files properly, which may appear as plugin errors.

What about the original revtree plugin?

It supersedes the SvnCcHelpersScript/RevTree plugin:

  1. it does not rely on any Clearcase external scripts nor on any SVN custom properties to build the graph,
  2. it does not use the GraphvizPlugin nor the Graphviz (dot) tool to render the graph. It is a pure Python implementation,
  3. it uses the Trac repository cache, which dramatically speeds up the generation of the graph
  4. it can be configured and extended to support custom repository organization

The older plugin code has been removed from the TracHacks.org repository.

Libraries

The RevtreePlugin uses the following libraries:

  • Genshi, the XML templating system used in Trac
  • Jquery a lightweight, yet powerful Javascript library
  • SVGdraw is a Python library that enables SVG generation -- User Note: Seems to be included, and is nowhere else in Google

Bugs/Feature Requests

Existing bugs and feature requests for RevtreePlugin are here. If you have any issues, create a new ticket.

Recent Changes

[13844] by eblot on 2014-04-09 15:50:23
Creates a new directory for Revtree dedicated to Trac 1.1+ installations
[13716] by eblot on 2014-03-03 09:59:13
Closes #7608. Remove seed initializer, keep random color generation in case a branch is not named (which should never happen)
[13715] by eblot on 2014-03-03 09:54:57
Refs #9231. This new version addressed some of the StopIteration issues that sometimes trigger within Revtree

Author/Contributors

Author: eblot
Maintainer: eblot
Contributors: Remi Verchère, Emmanuel Bouaziz, Sylvain Delisle

Last modified 4 months ago Last modified on Mar 3, 2014 9:37:27 AM

Attachments (10)

Download all attachments as: .zip