Changes between Version 29 and Version 30 of TracTicketChangelogPlugin


Ignore:
Timestamp:
Apr 4, 2017, 9:48:25 AM (5 years ago)
Author:
Ryan J Ollos
Comment:

Minor edits.

Legend:

Unmodified
Added
Removed
Modified
  • TracTicketChangelogPlugin

    v29 v30  
    55== Description
    66
    7 This plugin adds a changelog list in a Trac ticket. You do not need to switch from your coding environment to your browser and your comment ticket anymore to see this changeset.
     7This plugin adds a changelog list in a Trac ticket.
    88
    9 Just compose your log message following the pattern. The default pattern in versions 0.12 and 1.0 of the plugin is to add #ticketid before the log messages.
     9Compose your log message with a ticket reference pattern. The default pattern in versions 0.12 and 1.0 of the plugin is to add #ticketid before the log messages.
    1010{{{
    1111#ticketid any messages
     
    1313
    1414In version 1.2 of the plugin the [trac:CommitTicketUpdater] options are used
    15 to configure the pattern. With the default option, patterns such like `refs #1` and `fixes #2` will be matched.
     15to configure the pattern. With the default option values, patterns such like `refs #1` and `fixes #2` will be matched.
     16
     17[[Image(ticketlog.png)]]
    1618
    1719Tested with Subversion, Mercurial and Git.
     
    1921=== Mercurial
    2022
    21 For mercurial backend, since [t:#8417 TracMecurial does not support repository cache] yet, you should install [http://github.com/maraujop/TracMercurialChangesetPlugin TracMercurialChangesetPlugin] to generate the repository cache.
     23For mercurial backend, since TracMecurial [t:#8417 does not support the repository cache] yet, you should install [http://github.com/maraujop/TracMercurialChangesetPlugin TracMercurialChangesetPlugin] to generate the repository cache.
    2224
    2325=== Git
    2426
    25 For git backend, according to #7746, you should add following config to git section in the `trac.ini` file:
     27For the Git backend, you should add following config to the `[git]` section of your `trac.ini` file:
    2628{{{#!ini
    2729[git]
     
    3032}}}
    3133
    32 You might need to run `trac-admin repository resync` after the change.
    33 
    34 == Example
    35 
    36 For example, when you commit for ticket #10, the commit log like:
    37 {{{
    38 #10 fixed blog
    39 }}}
    40 And you got a revision [1234]. After that, when open ticket #10, you can see a change log list:
    41 
    42 [[Image(ticketlog.png)]]
     34You need to run `trac-admin repository resync` after the change.
    4335
    4436== Bugs/Feature Requests
     
    7062python setup.py compile_catalog -f
    7163}}}
    72  1. If you want to install this plugin globally, that will install this plugin to the Python path:
     64 1. If you want to install this plugin globally, will install this plugin to the Python path:
    7365  * python setup.py install
    7466 1. If you want to install this plugin to the Trac instance only: