Changes between Version 11 and Version 12 of MultiProjectCommitTicketUpdaterPlugin

Timestamp:

Mar 9, 2022, 7:09:21 AM (2 years ago)

Author:

figaro

Comment:

Move example to functional description

MultiProjectCommitTicketUpdaterPlugin

@@ -8 +8 @@
 
 This plugin is based on `commit_ticket_updater` by Edgewall Software.
+
+Once you have set up the plugin, you can add comments to tickets using something like this:
+
+{{{#!sh
+svn commit -m "Re my-other-project:#12, #13, changed blah and foo to do this and that. Closes my-project:#10 and #12."
+}}}
 
 See also:
@@ -49 +55 @@
 }}}
 
-Set the [trac:CommitTicketUpdater#Configure CommitTicketUpdater options]. Additionally, the `[ticket]` `commit_ticket_update_short_name` should be set to the token that you wish to use when referencing tickets. The value defaults to the environment name (i.e. the name of the environment directory).
+== Configuration
 
+Set the [trac:CommitTicketUpdater#Configure CommitTicketUpdater options]. Additionally, the `commit_ticket_update_short_name` should be set to the token that you wish to use when referencing tickets. The value defaults to the environment name, i.e. the name of the environment directory:
+{{{#!ini
+[ticket]
+commit_ticket_update_short_name = project-token
+}}}
 
-=== Caveats
-
+There are some additional configuration considerations post installation of this plugin:
 * You must set up a repository hook for this plugin to work, in the same way as for the inbuilt commit ticket updater tool. See trac:TracRepositoryAdmin#ExplicitSync for more details.
-
 * The plugin must be enabled in every project which will be using it. The simplest way to do this is with a shared global configuration file, see trac:TracIni#GlobalConfiguration.
-
-== Example
-
-Once you have set up the plugin, you can add comments to tickets using something like this:
-
-{{{#!sh
-svn commit -m "Re my-other-project:#12, #13, changed blah and foo to do this and that. Closes my-project:#10 and #12."
-}}}
 
 == Recent Changes