Edgewall Software

Changes between Version 31 and Version 32 of TracMercurial


Ignore:
Timestamp:
Jan 22, 2007, 9:37:08 AM (15 years ago)
Author:
Christian Boos
Comment:

Simplify the installation instructions by clearly separating the 0.10 and 0.11 versions of the plugin

Legend:

Unmodified
Added
Removed
Modified
  • TracMercurial

    v31 v32  
     1[[PageOutline(2-3)]]
    12= Mercurial Plugin for Trac (#1847) =
    23
    3 There is an '''experimental''' plugin for Trac [milestone:0.10]
     4There is an '''experimental''' plugin for Trac [milestone:0.10] and  Trac [milestone:0.11]
    45which enables [http://www.selenic.com/mercurial Mercurial]
    56to be used instead of [http://subversion.tigris.org Subversion]
     
    1112Change Logs:
    1213 * log:sandbox/mercurial-plugin
    13  * log:sandbox/vc-refactoring
     14 * log:sandbox/mercurial-plugin-0.11
    1415
    1516== Download and Installation ==
    16 
    17 ==== Trac ====
    18 The plugin needs a slightly modified version of Trac 0.10.
    19 This version can be found in source:sandbox/vc-refactoring.
    20 
    21 Simply do one of (see revision table below):
    22 
    23  1. Use Trac [milestone:0.10] (see TracDownload)
    24     and install it (see TracInstall)
    25 
    26  2. or use the version in trunk ([milestone:0.11]dev).
    27     The advantage being that you don't need ClearSilver anymore.
    28     It also supports of the new features added in 0.11 to the TracBrowser:
    29      - quickjump to a tag or branch
    30      - blame support
    31      - custom property renderers
     17=== Trac ===
     18==== Trac 0.10 ====
     19
     20The plugin [source:sandbox/mercurial-plugin] works fine with Trac 0.10.3, though it will lack the "quickjump" to a branch or tag feature (this was implemented in source:sandbox/vc-refactoring, but is only available in the mainline for 0.11).
     21
     22See TracDownload and install Trac the usual way (see TracInstall)
     23
     24The plugin itself is available from source:sandbox/mercurial-plugin
     25
     26Check it out:
     27
     28{{{
     29svn co http://svn.edgewall.com/repos/trac/sandbox/mercurial-plugin
     30}}}
     31and create an "egg" from there
     32{{{
     33$ cd mercurial-plugin
     34$ python setup.py bdist_egg
     35}}}
     36
     37==== Trac 0.11 ====
     38
     39There's a newer version of the plugin  [source:sandbox/mercurial-plugin-0.11] which has been adapted to work with the trunk version of Trac ([milestone:0.11]dev) and is kept in sync with it.
     40
     41One of the advantage of using this version is that you won't need to install ClearSilver anymore; instead you'll need the Genshi template engine (which is Python only, and therefore straightforward to install).
     42
     43That version of the Mercurial plugin also supports of the new features added in 0.11 to the TracBrowser:
     44 - quickjump to a tag or branch
     45 - blame support
     46 - custom property renderers ([souce:sandbox/property-renderers-tmp], not yet in trunk)
     47
    3248{{{
    3349svn co http://svn.edgewall.com/repos/trac/trunk trac
     
    4460(for Genshi, you might prefer to use a packaged release, see Genshi:GenshiDownload, or to easy_install it)
    4561
    46 The plugin itself is available from source:sandbox/mercurial-plugin
    47 
    48 Check it out, too:
    49 
    50  1. If you are using Trac [milestone:0.10]
    51 {{{
    52 svn co http://svn.edgewall.com/repos/trac/sandbox/mercurial-plugin
    53 }}}
    54 and create an "egg" from there
    55 {{{
    56 $ cd mercurial-plugin
    57 $ python setup.py bdist_egg
    58 }}}
    59  2. If you are using Trac [milestone:0.11]dev
     62Then, you need the plugin itself:
    6063{{{
    6164svn co http://svn.edgewall.com/repos/trac/sandbox/mercurial-plugin-0.11
    6265}}}
    63 and create an "egg" from there
     66create an "egg" from there:
    6467{{{
    6568$ cd mercurial-plugin-0.11
     
    7073[http://peak.telecommunity.com/DevCenter/setuptools setuptools] >= 0.6 for that (I used setuptools-0.6a9).
    7174
    72 ===== Releases =====
     75==== Releases ====
    7376|| '''Version''' || mercurial-plugin || Trac vc-refactoring || Compatible with hg         ||
    74 ||   '''0.3'''   ||    ''latest-0.11''   || [milestone:0.11] or [source:trunk] ||  0.7, 0.8, 0.9, tip  ||
    75 ||   '''0.2'''   ||    ''latest''   || [milestone:0.10] ||  0.7, 0.8, 0.9, tip  ||
    76 ||   '''0.2'''   ||    '''r3014'''   || [source:trunk@2900] ||  0.7, 0.8, tip  ||
    77 ||   '''0.2'''   ||    '''r2905'''   ||     '''r2905'''     ||  0.7, 0.8, tip  ||
     77|| '''0.11.0.1'''|| ''latest-0.11''  || [milestone:0.11] or [source:trunk] || 0.9, tip  ||
     78|| '''0.10.0.2'''|| ''0.10-stable''  || [milestone:0.10]    ||  0.7, 0.8, 0.9, tip  ||
     79||      0.2      ||    '''r3014'''   || [source:trunk@2900] ||  0.7, 0.8, tip  ||
     80||      0.2      ||    '''r2905'''   ||     '''r2905'''     ||  0.7, 0.8, tip  ||
    7881||               ||       r2620      ||        r2620        ||  0.7, tip with 1d7d0c07    ||
    7982||      0.1      ||       r2514      ||        r2511        ||  0.7, tip without 1d7d0c07 ||
    8083
    8184
    82 ==== Mercurial ====
     85=== Mercurial ===
    8386The plugin has been tested with recent development versions of Mercurial
    8487(upto Changeset 3324:34f08b8883cf from http://selenic.com/hg)
    8588and also with Mercurial 0.7 and 0.8.
    8689'''It won't work with earlier versions, in particular not with 0.6x.'''
     90
     91The plugin for 0.11 takes benefit of some new features introduced after the 0.8.2 release of Mercurial, and therefore needs at least a 0.9 version of Mercurial.
    8792
    8893You can download Mercurial itself from
     
    111116If you installed the egg globally and you're modifying an
    112117existing Trac environment to use the Mercurial backend,
    113 then you have to explicitely ''enable'' the plugin in TracIni:
     118then you have to explicitely ''enable'' the plugin in TracIni.
     119
     120For the 0.10 plugin, this is done like that:
    114121{{{
    115122[components]
     
    117124}}}
    118125
    119 Note: on dec 10 2006, using svn version of both trac and TracMercurial, I had to replace the above with
     126For the 0.11 plugin, the package has been renamed to `tracext`:
    120127{{{
    121128[components]
     
    130137For general instructions, see TracInstall.
    131138
    132 Since milestone:0.10, the TracAdmin `initenv` command has
     139Since [milestone:0.10], the TracAdmin `initenv` command has
    133140now a ''repository type'' argument besides ''repository directory''.
    134141
     
    164171even if there's currently ''no'' caching in the database
    165172(this is what I'm going to work on next).
     173Don't even think about using the plugin on a Linux-kernel-sized Mercurial repository, you'll probably burn your disk and/or CPUs ;)
    166174
    167175For those used to Subversion in general and Subversion repository browsing
     
    204212
    205213
    206 === TracBrowser changes ===
     214=== TracBrowser changes in [milestone:0.11] ===
    207215
    208216The TracBrowser ''View revision'' form has been extended with
    209217pulldown menus for jumping to a given tag or branch (in Mercurial,
    210218a branch within a repository corresponds to a head, i.e. a
    211 changeset without children): [[Image(hg-plugin-browser.png)]]
    212 
    213 ''has to be re-added''
     219changeset without children):
     220----
     221[[Image(hg-plugin-browser.png)]]
     222----
     223There's also support for visual ''blame'' annotations:
     224----
     225[[Image(wiki:ChristianBoos:blame-screenshot2.png)]]
    214226
    215227== Bugs and Limitations ==