Changes between Version 21 and Version 22 of CommitTicketUpdater

Timestamp:

Aug 31, 2016, 10:58:05 PM (8 years ago)

Author:

figaro

Comment:

Further cosmetic changes

CommitTicketUpdater

@@ -16 +16 @@
 == Location
 
-The `CommitTicketUpdater` component lives in [source:trunk/tracopt/ticket/commit_updater.py 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 through the Admin interface.
+The `CommitTicketUpdater` component lives in [source:trunk/tracopt/ticket/commit_updater.py 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 through the Admin interface.
 
 == Enable
@@ -23 +23 @@
     a. !CommitTicketUpdater (tracopt.ticket.commit_updater.*)
     b. !CommitTicketReferenceMacro (tracopt.ticket.commit_updater.*)
- 1. Alternatively edit the `trac.ini` file, add the following line at the `[components]` section:
-{{{
+ 1. Alternatively edit the `trac.ini` file, by adding the following line in the `[components]` section:
+{{{#!ini
+[components]
 tracopt.ticket.commit_updater.* = enabled
 }}}
 
-== Configure
+== Configuration
 
-{{{
+There are also the following configurations to be set in the `trac.ini` file:
+{{{#!ini
 [ticket]
 commit_ticket_update_envelope = []
@@ -39 +41 @@
 }}}
 
-Where,
+Where:
  * `commit_ticket_update_envelope` sets the required commands to be enclosed in an envelope.
      * Must be empty not to require an envelope;
-     * or contain two characters. For example, if set to "[]", then commands must be in the form of `[closes #4]`.[[BR]][[BR]]
+     * or contain two characters. For example, if set to "[]", then commands must be in the form of `[closes #4]`.
+
  * `commit_ticket_update_commands.close`: has a space-separated list, with commands that close tickets.
-    * Default values to **close** a ticket: //close closed closes fix fixed fixes// [[BR]][[BR]]
+    * Default values to **close** a ticket: //close closed closes fix fixed fixes//
+
  * `commit_ticket_update_commands.refs`: has a space-separated list, with commands that add a reference to tickets.
     * Default values to **reference** a ticket: //addresses re references refs see//
-    * If set to the special value //<ALL>//, all tickets referenced by the message will get a reference to the changeset.[[BR]][[BR]]
+    * If set to the special value //<ALL>//, all tickets referenced by the message will get a reference to the changeset.
+
  * `commit_ticket_update_check_perms` when //true// checks that the committer has permission to perform the requested operations on the referenced tickets
-    * Values: //true//, //false//[[BR]][[BR]]
+    * Values: //true//, //false//
+
  * `commit_ticket_update_notify`, when //true// send ticket change notification when updating a ticket.
     * Values: //true//, //false//
@@ -67 +73 @@
 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. The word 'and' is also allowed between ticket numbers.
 
-You can optionally refer to tickets with the following words
+You can optionally refer to tickets with the following words:
 * //ticket//, //issue//, //bug//