Changes between Version 5 and Version 6 of CommitTicketUpdater

Timestamp:

Mar 15, 2011, 1:40:20 PM (13 years ago)

Author:

Floris Lambrechts <floris.lambrechts@…>

Comment:

Syntax examples

CommitTicketUpdater

@@ -14 +14 @@
 === Location ===
 The `CommitTicketUpdater` component lives in `source:trunk/tracopt/ticket/commit_updater.py` and is maintained alongside the Trac core. It's included with every Trac installation as a plugin, but is not enabled by default because it's rooted in the `tracopt.` packages and not in `trac.`.   Therefore it needs to be explicitly activated (e.g. trough the Admin interface).
+
+=== Syntax ===
+The basic syntax is of the form `[command] [ticketreference]`. A colon between the command and the ticket reference is allowed. The ticketreference also allows to list //multiple// ticket numbers separated by spaces and/or comma.
+
+You can use the following commands:
+* To **close** a ticket: //close//, //closed//, //closes//, //fix//, //fixed//, //fixes//
+* To **reference** a ticket: //addresses//, //re//, //references//, //refs//, //see//
+
+You can optionally refer to tickets with the following words
+* //ticket//, //issue//, //bug//
+
+Examples:
+* `close #10`
+* `closed: #10`
+* `closes ticket #10`
+* `fixes #10`
+* `fixes bug: #10`
+* `see #5`
+* `references #5, #6`
+* `fixes #10 #11`